{
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"openapi": "3.1.1",
"info": {
"title": "Rentman API Documentation",
"version": "1.16.0",
"description": "Rentman API is an easy-to-use **RESTful** inspired API.\n\n# Versions\n\nWe only support one version of the API. Integrations are automatically migrated when a new version comes online.\n\nYou can find the recent changes here: Rentman API Changelog\n\nLast deployment is **2026-08-25 14:55**.\n\n### Receive updates\nTo receive updates and major changes to our integrations and API, and to allow us to contact you if we notice that one of your integrations is not working properly, please make sure to fill in the **technical contact details** (in *Configuration* -> *Company details* -> *Contact persons*).\n\n\n# Introduction\n\nThis API enables you to interact with Rentman programmatically. You can use this API to create automatic\nsynchronisations, connect other software applications, or develop any other type of integration. This page documents all\nthe resources available in the Rentman API. The amount of resources is limited for now but more data types will be added\nat a later stage. You can request more data types by getting in touch via\nour Public Roadmap.\n\nTo further improve the Rentman API we would like to know what kind of integrations you are developing. \nPlease share us your ideas or already developed connections at support@rentman.io\n\n## Authentication\n\nRentman uses **JWT** for authentication. This token is unique for every Rentman user. The **JWT** can be generated in\nthe **integrations** tab in **configuration** in the Rentman application. Only the last generated token will be a valid\ntoken. When regenerating a token the previous token will not work anymore.\n\n## Headers\n\nEach request to this API expects some request headers to be set.\n\n- `Content-Type` - This should always be set to `application/json`\n- `Authorization` - This header should be of the form `Bearer `, where `token` is the JWT from the rentman\n account.\n\n## Response Format\n\nEvery successful `GET` response from the Rentman Open API is a JSON object consisting of a `data` key and other\nmetadata. The `data` key contains an array of JSON objects representing the requested items if the request is for a\ncollection. The `data` key contains a JSON object representing the requested item if the request is for one item.\nThe `data` key responses of `POST` and `PUT` contain the created and updated items respectively. Successful `DELETE`\nrequests don't have responses. The keys other than the `data` key are:\n\n- `itemCount` - The amount of items in the response.\n- `limit` - The maximal amount of items that can be returned. This equals the limit parameter if it is set. Otherwise,\n it is the response data limit.\n- `offset` - The amount of items skipped in the response items. This equals the offset parameter if it is set.\n Otherwise, it is `0`. All the keys are always given when a response is present.\n\n## Expanding linked items\n\nFields that refence another resource normally return a path string pointing to the linked resource (e.g. `/crew/237`).\nUse the `expand` query parameter to inline the full linked object directly in the response instead.\n\n`expand` accepts a comma-separated list of field names. Nested expansions are expressed with dot notation.\n\n> Example: Return each serial number with its linked equipment object inlined.\n\n```\nGET https://api.rentman.net/serialnumbers?expand=equipment\n```\n\n```json\n{\n \"data\": [\n {\n \"id\": 41,\n \"serial\": \"Yamaha-01\",\n \"equipment\": {\n \"id\": 12,\n \"name\": \"Yamaha QL5 Mixer\",\n \"code\": \"AUD-001\",\n \"active\": true\n }\n }\n ]\n}\n```\n\nWithout `?expand`, `equipment` would be `\"/equipment/12\"`.\n\n> Example: Expand multiple fields and nest expansions.\n\n```\nGET https://api.rentman.net/serialnumbers?expand=equipment,equipment.creator\n```\n\nThis returns each serial number with its `equipment` expanded into an object, and within that object, `creator` also expanded. Nesting is supported up to 3 levels deep.\n\nWhen an expandable field is `null`, it remains `null` in the expanded response. Only fields of type `item` or `link` can be expanded — attempting to expand a non-linkable field returns a `400` error.\n\nYou can combine `expand` with the [`fields`](#section/Querying) parameter, using dot notation to select which fields of an expanded relation are returned. The relation must also be listed in `expand`; a nested `fields` path without a matching `expand` entry returns a `400` error.\n\n> Example: Return only the `serial` field of each serial number, and only the `name` of its expanded equipment.\n\n```\nGET https://api.rentman.net/serialnumbers?expand=equipment&fields=serial,equipment.name\n```\n\nAn expanded relation with no nested `fields` selection returns its default set of fields.\n\n## Querying\n\nThe Rentman API support several types of querying with query parameters:\n\n- `fields` - The value of the `fields` key is a set of all fields that are requested. For\n example, `displayname,firstname` will only return the displayname and the firstname of every object. There are some\n fields that will always be returned such as `id`, `created` and `modified`.\n- `sort` - The value of the `sort` key is a set of fields where the items are sorted on. For example, `+id,-firstname`\n will return an array of items first sorted on id ascending and then sorted on firstname descending.\n\nIt is also possible to filter on values of fields when requesting a collection of items.\n> Example: To only get the contacts situated in Great Britain, a query can be added with the key `country` and the value\n`gb`.\n\n```\nGET https://api.rentman.net/contacts?country=gb\n```\n\n### Relational operators\n\nThe following relational operators can be used for filtering:\n\n- `lt` - less than (`<`)\n- `gt` - greater than (`>`)\n- `lte` - less than or equal to (`<=`)\n- `gte` - greater than or equal to (`>=`)\n- `neq` - not equal to (`!=`). This can also be used with multiple values, in which case it behaves like 'not in'\n\n> Example: The filter `distance[lte]=300` can be used to only retrieve items with a distance less than or equal to 300.\n\n```\nGET https://api.rentman.net/contacts?distance[lte]=300\n```\n\n### Filtering null values\n\nFiltering on null values is possible by putting `[isnull]` behind a field name, followed by a boolean value, which can\nbe `true`, `false`, `1` or `0`.\n\n> Example: The filter `folder[isnull]=false` can be used to only retrieve items where the value of `folder` is not null.\n\n```\nGET https://api.rentman.net/contacts?folder[isnull]=false\n```\n\n### Pagination\n\nCollection responses include a `next_page_url` field that points to the next page of results. To paginate through a\ncollection, simply follow the `next_page_url` until it is `null`.\n\n- `limit` - The number of items per page on the first request (default: 300, max: 1500, see [Limitations](#section/Introduction/Limitations)). The limit is carried over\n automatically in subsequent pages via the cursor.\n\n> Example: Paginate through contacts in pages of 10 items.\n\n```\nGET https://api.rentman.net/contacts?limit=10\n```\n\nThe response includes:\n```json\n{\n \"data\": [...],\n \"itemCount\": 10,\n \"limit\": 10,\n \"next_page_url\": \"https://api.rentman.net/contacts?cursor=eyJhZnRlciI6NDU2LCJvcmRlciI6ImRlc2MiLCJsaW1pdCI6MTB9\"\n}\n```\n\nTo get the next page, follow the `next_page_url`:\n\n```\nGET https://api.rentman.net/contacts?cursor=eyJhZnRlciI6NDU2LCJvcmRlciI6ImRlc2MiLCJsaW1pdCI6MTB9\n```\n\nWhen the last page is reached, `next_page_url` will be `null`.\n\nPagination can be combined with filters — the `next_page_url` will include all original filter parameters:\n\n```\nGET https://api.rentman.net/contacts?limit=10&country=gb\n```\n\n```\nhttps://api.rentman.net/contacts?country=gb&cursor=eyJhZnRlciI6NDU2LCJvcmRlciI6ImRlc2MiLCJsaW1pdCI6MTB9\n```\n\n> Note: The `cursor` parameter in the URL is an opaque token. Do not construct or modify it manually — always use\n> the `next_page_url` as-is.\n\n### Limiting result sets\n\nIf you want to fetch a top 10 of items based on sorting on an arbitrary field, you can use the sorting option described\nearlier and apply a `limit` to get only that number of items.\n\n> Example: To request the first 30 items sorted by firstname:\n\n```\nGET https://api.rentman.net/contacts?limit=30&sort=+firstname\n```\n\n## Limitations\n\n### Possible sort inconsistencies\n\nEvery request sent to the Rentman API also sends a request to the Rentman backend to retrieve information. All query\nparameters that are given to a Rentman API request are also given the Rentman backend request, except for the sorting\nparameter. Due to limitations, when pagination and sorting is applied at the same time only the first field of the\nsorting parameter can be used before paginating in the Rentman backend. When the Rentman API retrieves the paginated\nitems from the Rentman backend, the items will be sorted and returned. This results in a pagination sorted only on the\nfirst sorting field and can cause some inconsistencies where items that are supposed to be on the page request by the\nsecond or third sorting parameter are on different pages since these sort parameters are not taken into account when\npaginating.\n\nThis issue can only exist when sorting on multiple fields and paginating at the same time.\n\n### Generated fields\n\nSome fields contain a `GENERATED FIELD` tag. All fields with this tag cannot be used for sorting while the `limit`\nparameter is not empty. Generated fields are fields that the Rentman backend computes and are not stored\nin the database.\n\nThis is a limitation due to the way these parameters are computed in the API. Every request sent to the Rentman API also\nsends a request to the Rentman backend to retrieve information. The `limit` parameter is added to this\nrequest to the Rentman backend. If there is a sorting parameter given to the Rentman API request, the first field of the\nsorting parameter is also sent with the Rentman backend request. The Rentman backend then sorts and returns a subset of\nthe items as defined by the query parameters of the Rentman API request. Due to limitations of the Rentman backend, the\nsort value that is sent to the Rentman backend cannot be one of the generated fields.\n\nThe fields containing `GENERATED FIELD` are also not queryable for filtering.\n\n## Omitted fields in list requests\n\nTo keep requests at a low cost, some fields of items are omitted when in a collection request when not specifying fields. \nTo get the values of these fields, request them using the `?fields` parameter.\nThe fields that are returned are specified in the documentation for the specific requests.\n\n## Custom fields\n\nCustom fields can be accessed via the `custom` key in `data`. These custom fields will have generic keys with the\nformat `custom_`. They are expandable and filterable like normal fields.\n\n## Custom child collections\n\nThe Rentman API borrows the link structure from Rentman backend in most cases. However, some useful links (\ne.g. `projects` linking to `plannedequipment`) do not exist in the Rentman backend. For the Rentman API these links are\ncustom implemented and can be recognized by the `Get custom linked collection` title.\ne.g. `Get plannedequipment custom linked collection` for `projects`. It will never be possible to create items through\nthese linked collections since these links don't actually exist in the Rentman backend. It may also be possible that\nrelevant parent fields are missing in these custom children.\n\n## updateHash\n\nEvery item that is requested also contains a field `updateHash`. This is a field that is generated by the Rentman API\nand is a hash value computed with the `id` and `modified` field of the item. This hash can therefore be used to\nrecognize when an item is updated, since this field is unique per item and per update of that item.\n\n## Response data limitation\n\nResponses to collection requests default to 300 items when no `limit` parameter is specified. You can request up to 1500\nitems per request by setting the `limit` parameter. Additionally, there is a maximum response size of 5 MB. If you need\nmore than 1500 items, use pagination to iterate through the results. If the response exceeds 5 MB you will receive an\nerror. Use the `limit` parameter to request fewer items, or use the `fields` parameter to filter unnecessary fields\nfrom the response.\n\n## Rate limitation\n\nThe rate at which requests can be sent to the Rentman API is limited to 50.000 requests per day, and 10 requests per second. A maximum of 20 requests can be sent at once.\n",
"x-logo": {
"url": "https://cdn.prod.website-files.com/680b7c8bdefaec9c53251168/6877620893893ba9994b2a11_rentman-logo.svg",
"altText": "Rentman",
"href": "https://rentman.io"
}
},
"servers": [
{
"url": "https://api.rentman.net"
}
],
"tags": [
{
"name": "accessories",
"description": "Represents accessories of an equipment item. Each equipment can have multiple accessories. Accessories are equipment items themselves."
},
{
"name": "actualcontent",
"description": "Represents the actual content of serialized physical combinations"
},
{
"name": "alternatives",
"description": "Represents alternatives of an equipment item. Each equipment can have multiple alternatives. Alternatives are equipment items themselves."
},
{
"name": "appointmentcrew",
"description": "With this endpoint, you could retrieve which crew member is linked to an appointment"
},
{
"name": "appointments",
"description": "With this endpoint, you could read, write, update and delete appointments."
},
{
"name": "contactpersons",
"description": "Represents a person or department within a Contact. A Person item is always associated with one Contact"
},
{
"name": "contacts",
"description": "Represents a company or a private person"
},
{
"name": "contracts",
"description": "Represents contracts."
},
{
"name": "costs",
"description": "Represents additional costs in a project."
},
{
"name": "crew",
"description": "With this endpoint you can retrieve crew members and their information."
},
{
"name": "crewavailability",
"description": "Availability of the crew members."
},
{
"name": "crewrates",
"description": "Represents the rates attached to crew members."
},
{
"name": "equipment",
"description": "All equipment."
},
{
"name": "equipmentassignedserials",
"description": "With this endpoint, you can retrieve the serial numbers assigned to serialized physical combinations together with their information. This endpoint only returns serials which have been assigned manually from the serial numbers tab, not actual content. Please see this article for more information"
},
{
"name": "equipmentsetscontent",
"description": "With this endpoint, you can retrieve the contents of combinations together with their information."
},
{
"name": "extrainputfields",
"description": "With this endpoint, you can read extra input fields."
},
{
"name": "factorgroups",
"description": "All factor groups."
},
{
"name": "factors",
"description": "All factor."
},
{
"name": "file_folders",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field."
},
{
"name": "files",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field."
},
{
"name": "folders",
"description": "Contacts, equipment, crew, vehicles, containers, projecttemplates and default functions are organised into folders"
},
{
"name": "invitations",
"description": "With this endpoint, you can read sent invitations for crew functions."
},
{
"name": "invoicelines",
"description": "Invoice lines are generated lines based on tax rates and ledgers of the items within an invoice. They sum up to the total of the invoice. Useful for exporting to accounting systems. It is currently not possible to get the exact same details which are displayed on the invoice pdf, since that depends on the used document template."
},
{
"name": "invoices",
"description": "Represents invoices."
},
{
"name": "leavemutation",
"description": "With this endpoint, you could work with leave mutations and their information.\n\nThese items are immutable, so any mistakes made in the mutations should be corrected by creating a new (opposite) mutation.\n\nDuration is expressed in seconds."
},
{
"name": "leaverequest",
"description": "With this endpoint, you could work with leave requests and their information.\n\nMake sure to also create the corresponding request lines for this request (by using the `/leaverequest/:id/timeregistration` endpoint).\n\nThe leave type for the request lines must require approval (See `/leavetypes` endpoint for this information).\n\nHours requests can be updated as long as they are in status 'Pending', once they get Approved/Rejected they can't be updated anymore besides transitioning a request from Approved to Cancelled.\n\nOnce created, the crew member the request is for can't be updated."
},
{
"name": "leavetypes",
"description": "With this endpoint, you could work with leave types and their information."
},
{
"name": "ledgercodes",
"description": "Ledger codes are the codes defining the type of trade for an invoice line."
},
{
"name": "payments",
"description": "Represents payments."
},
{
"name": "projectcrew",
"description": "Represents the planning of crewmembers on Functions"
},
{
"name": "projectequipment",
"description": "Represents equipment items planned in a project."
},
{
"name": "projectequipmentgroup",
"description": "Equipment groups of a project."
},
{
"name": "projectfunctiongroups",
"description": "Function groups inside a project"
},
{
"name": "projectfunctions",
"description": "A function is a task that needs to be performed. Functions are connected to subprojects (and projects). Functions can be grouped inside function groups."
},
{
"name": "projectrequestequipment",
"description": "Project Request Equipment are equipment items linked to the Project Request. You can use this to add equipment items in a raw data format to the Project Request. The equipment items will be matched to the existing equipment items in the account when converting the Project Request into a Project in the Rentman interface."
},
{
"name": "projectrequests",
"description": "Project Requests are incoming requests from external sources that allows you to turn into projects. These could come from another Rentman user, that is using the internal subrent request feature. By making also the POST endpoint available in the API, you can now also push these from other applications. For example from your CRM system, a form on your website, or any other source. The benefit of using Project Requests is that you can provide the data in a raw format. While converting a Project Request into a project from the Rentman interface, you can match this data to existing contacts, equipments etc. No need to set up complicated logic to fetch these items using the API first."
},
{
"name": "projects",
"description": "Projects are the cornerstone of Rentman. Projects are connected to many other items. Projects always include one or more subprojects. When the user interface does not show any subprojects there is in fact a single one. See the /subprojects endpoint for more information."
},
{
"name": "projectstatuses",
"description": "Get project status objects"
},
{
"name": "projecttypes",
"description": "Get a specific project type."
},
{
"name": "projectvehicles",
"description": "Represents the vehicles planned for a function."
},
{
"name": "purchaseordercosts",
"description": "Represents line items within a purchase order."
},
{
"name": "purchaseorderglobalcosts",
"description": "Represents global costs of a purchase order."
},
{
"name": "purchaseorders",
"description": "Represents purchase orders."
},
{
"name": "quotes",
"description": "Represents quotes."
},
{
"name": "ratefactors",
"description": "Represents the rate factors for the crew rates."
},
{
"name": "rates",
"description": "Represents crew rates."
},
{
"name": "repairs",
"description": "With this endpoint you can retrieve repairs and their information."
},
{
"name": "serialnumbers",
"description": "Represents serial numbers, which are specific individual equipment pieces. This is a sub-item of Equipment and is always associated with a single Equipment item."
},
{
"name": "statuses",
"description": "Get a status objects"
},
{
"name": "stocklocations",
"description": "With this endpoint, you can retrieve the stock locations and their information."
},
{
"name": "stockmovements",
"description": "Stock movements are all the changes that happen to the stock levels of an equipment. Those changes include manual changes, purchases, sales, transfers, stock corrections, repairs, marking lost or found, imports, stock counts. When creating or updating stock movements via the API only stock movements of type 'manual' are writable. Only stock movements for bulk items are available though the API. Stock movements for serialized equipment may be implemented at a later stage."
},
{
"name": "subprojects",
"description": "Subprojects are part of projects. All projects include at least one subproject. Information that differs from subproject to subproject, e.g. location, is retrieved in this endpoint."
},
{
"name": "subrentalequipment",
"description": "With this endpoint you can retrieve information about subrental equipment."
},
{
"name": "subrentalequipmentgroup",
"description": "With this endpoint you can retrieve information about subrental equipment groups."
},
{
"name": "subrentals",
"description": "With this endpoint you can retrieve subrentals and their information."
},
{
"name": "subtasks",
"description": "With this endpoint, you can read, write, update and delete subtasks."
},
{
"name": "suppliers",
"description": "Represents a supplier relationship between a contact and an equipment item. Each supplier entry links a contact to an equipment item, optionally with a purchase price and additional details."
},
{
"name": "taskassignments",
"description": "With this endpoint, you can read, write, update and delete task assignments."
},
{
"name": "tasks",
"description": "With this endpoint, you can read, write, update and delete tasks."
},
{
"name": "taskstatuses",
"description": "With this endpoint, you can read, write, update and delete task statuses."
},
{
"name": "taxclasses",
"description": "Represents tax classes, which can be used to configure taxation rates."
},
{
"name": "timeregistration",
"description": "With this endpoint, you could retrieve time registrations and their information."
},
{
"name": "timeregistrationactivities",
"description": "With this endpoint, you could retrieve the activities of the time registrations and their information."
},
{
"name": "vehicles",
"description": "Represents vehicles."
},
{
"name": "warehousestatuses",
"description": "Get warehouse status objects"
}
],
"paths": {
"/accessories": {
"get": {
"summary": "Get Accessory collection.",
"operationId": "getAccessoryCollection",
"description": "Represents accessories of an equipment item. Each equipment can have multiple accessories. Accessories are equipment items themselves.",
"tags": [
"accessories"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessoryResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/accessories/{id}": {
"get": {
"summary": "Get Accessory item.",
"operationId": "getAccessoryItem",
"description": "",
"tags": [
"accessories"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AccessoryResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Accessory item.",
"operationId": "updateAccessory",
"description": "",
"tags": [
"accessories"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AccessoryResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessoryRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Accessory item.",
"operationId": "deleteAccessory",
"description": "",
"tags": [
"accessories"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/actualcontent": {
"get": {
"summary": "Get ActualContent collection.",
"operationId": "getActualContentCollection",
"description": "Represents the actual content of serialized physical combinations",
"tags": [
"actualcontent"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActualContentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/actualcontent/{id}": {
"get": {
"summary": "Get ActualContent item.",
"operationId": "getActualContentItem",
"description": "",
"tags": [
"actualcontent"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ActualContentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/alternatives": {
"get": {
"summary": "Get Alternative collection.",
"operationId": "getAlternativeCollection",
"description": "Represents alternatives of an equipment item. Each equipment can have multiple alternatives. Alternatives are equipment items themselves.",
"tags": [
"alternatives"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AlternativeResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/alternatives/{id}": {
"get": {
"summary": "Get Alternative item.",
"operationId": "getAlternativeItem",
"description": "",
"tags": [
"alternatives"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AlternativeResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Alternative item.",
"operationId": "updateAlternative",
"description": "",
"tags": [
"alternatives"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AlternativeResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlternativeRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Alternative item.",
"operationId": "deleteAlternative",
"description": "",
"tags": [
"alternatives"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/appointmentcrew": {
"get": {
"summary": "Get AppointmentCrew collection.",
"operationId": "getAppointmentCrewCollection",
"description": "With this endpoint, you could retrieve which crew member is linked to an appointment",
"tags": [
"appointmentcrew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppointmentCrewResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/appointmentcrew/{id}": {
"get": {
"summary": "Get AppointmentCrew item.",
"operationId": "getAppointmentCrewItem",
"description": "",
"tags": [
"appointmentcrew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppointmentCrewResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update AppointmentCrew item.",
"operationId": "updateAppointmentCrew",
"description": "",
"tags": [
"appointmentcrew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppointmentCrewResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentCrewRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete AppointmentCrew item.",
"operationId": "deleteAppointmentCrew",
"description": "",
"tags": [
"appointmentcrew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/appointments": {
"get": {
"summary": "Get Appointment collection.",
"operationId": "getAppointmentCollection",
"description": "With this endpoint, you could read, write, update and delete appointments.",
"tags": [
"appointments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppointmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create Appointment item.",
"operationId": "createAppointment",
"description": "",
"tags": [
"appointments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppointmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentRequest"
}
}
}
}
}
},
"/appointments/{id}": {
"get": {
"summary": "Get Appointment item.",
"operationId": "getAppointmentItem",
"description": "",
"tags": [
"appointments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppointmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Appointment item.",
"operationId": "updateAppointment",
"description": "",
"tags": [
"appointments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppointmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Appointment item.",
"operationId": "deleteAppointment",
"description": "",
"tags": [
"appointments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/appointments/{id}/appointmentcrew": {
"get": {
"summary": "Get AppointmentCrew collection.",
"operationId": "getAppointmentAppointmentCrewCollection",
"description": "With this endpoint, you could retrieve which crew member is linked to an appointment",
"tags": [
"appointments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppointmentCrewResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create AppointmentCrew item.",
"operationId": "createAppointmentCrew",
"description": "",
"tags": [
"appointments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AppointmentCrewResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppointmentCrewRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contactpersons": {
"get": {
"summary": "Get ContactPerson collection.",
"operationId": "getContactPersonCollection",
"description": "Represents a person or department within a Contact. A Person item is always associated with one Contact",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPersonResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/contactpersons/{id}": {
"get": {
"summary": "Get ContactPerson item.",
"operationId": "getContactPersonItem",
"description": "",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContactPersonResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update ContactPerson item.",
"operationId": "updateContactPerson",
"description": "",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContactPersonResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactPersonRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete ContactPerson item.",
"operationId": "deleteContactPerson",
"description": "",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contactpersons/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getContactPersonFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contactpersons/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getContactPersonFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contactpersons/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getContactPersonTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"contactpersons"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contacts": {
"get": {
"summary": "Get Contact collection.",
"operationId": "getContactCollection",
"description": "Represents a company or a private person",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create Contact item.",
"operationId": "createContact",
"description": "",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContactResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRequest"
}
}
}
}
}
},
"/contacts/{id}": {
"get": {
"summary": "Get Contact item.",
"operationId": "getContactItem",
"description": "",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContactResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Contact item.",
"operationId": "updateContact",
"description": "",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContactResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Contact item.",
"operationId": "deleteContact",
"description": "",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contacts/{id}/contactpersons": {
"get": {
"summary": "Get ContactPerson collection.",
"operationId": "getContactContactPersonCollection",
"description": "Represents a person or department within a Contact. A Person item is always associated with one Contact",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPersonResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create ContactPerson item.",
"operationId": "createContactPerson",
"description": "",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContactPersonResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactPersonRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contacts/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getContactFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contacts/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getContactFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contacts/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getContactTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"contacts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contracts": {
"get": {
"summary": "Get Contract collection.",
"operationId": "getContractCollection",
"description": "Represents contracts.",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContractResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/contracts/{id}": {
"get": {
"summary": "Get Contract item.",
"operationId": "getContractItem",
"description": "",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContractResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contracts/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getContractFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contracts/{id}/invoicelines": {
"get": {
"summary": "Get InvoiceLine collection.",
"operationId": "getContractInvoiceLineCollection",
"description": "Invoice lines are generated lines based on tax rates and ledgers of the items within an invoice. They sum up to the total of the invoice. Useful for exporting to accounting systems. It is currently not possible to get the exact same details which are displayed on the invoice pdf, since that depends on the used document template.",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceLineResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/contracts/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getContractTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"contracts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/costs": {
"get": {
"summary": "Get ProjectCost collection.",
"operationId": "getProjectCostCollection",
"description": "Represents additional costs in a project.",
"tags": [
"costs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCostResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/costs/{id}": {
"get": {
"summary": "Get ProjectCost item.",
"operationId": "getProjectCostItem",
"description": "",
"tags": [
"costs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectCostResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update ProjectCost item.",
"operationId": "updateProjectCost",
"description": "",
"tags": [
"costs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectCostResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCostRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete ProjectCost item.",
"operationId": "deleteProjectCost",
"description": "",
"tags": [
"costs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew": {
"get": {
"summary": "Get Crew collection.",
"operationId": "getCrewCollection",
"description": "With this endpoint you can retrieve crew members and their information.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/crew/{id}": {
"get": {
"summary": "Get Crew item.",
"operationId": "getCrewItem",
"description": "",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CrewResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew/{id}/appointments": {
"get": {
"summary": "Get Appointment collection.",
"operationId": "getCrewAppointmentCollection",
"description": "With this endpoint, you could read, write, update and delete appointments.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppointmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew/{id}/crewavailability": {
"get": {
"summary": "Get CrewAvailability collection.",
"operationId": "getCrewCrewAvailabilityCollection",
"description": "Availability of the crew members.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewAvailabilityResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create CrewAvailability item.",
"operationId": "createCrewAvailability",
"description": "",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CrewAvailabilityResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrewAvailabilityRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew/{id}/crewrates": {
"get": {
"summary": "Get CrewRates collection.",
"operationId": "getCrewCrewRatesCollection",
"description": "Represents the rates attached to crew members.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewRatesResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getCrewFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getCrewFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew/{id}/invitations": {
"get": {
"summary": "Get Invitations collection.",
"operationId": "getCrewInvitationsCollection",
"description": "With this endpoint, you can read sent invitations for crew functions.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvitationsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crew/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getCrewTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"crew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crewavailability": {
"get": {
"summary": "Get CrewAvailability collection.",
"operationId": "getCrewAvailabilityCollection",
"description": "Availability of the crew members.",
"tags": [
"crewavailability"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewAvailabilityResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/crewavailability/{id}": {
"get": {
"summary": "Get CrewAvailability item.",
"operationId": "getCrewAvailabilityItem",
"description": "",
"tags": [
"crewavailability"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CrewAvailabilityResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update CrewAvailability item.",
"operationId": "updateCrewAvailability",
"description": "",
"tags": [
"crewavailability"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CrewAvailabilityResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrewAvailabilityRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete CrewAvailability item.",
"operationId": "deleteCrewAvailability",
"description": "",
"tags": [
"crewavailability"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/crewrates": {
"get": {
"summary": "Get CrewRates collection.",
"operationId": "getCrewRatesCollection",
"description": "Represents the rates attached to crew members.",
"tags": [
"crewrates"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewRatesResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/crewrates/{id}": {
"get": {
"summary": "Get CrewRates item.",
"operationId": "getCrewRatesItem",
"description": "",
"tags": [
"crewrates"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CrewRatesResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment": {
"get": {
"summary": "Get Equipment collection.",
"operationId": "getEquipmentCollection",
"description": "All equipment.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create Equipment item.",
"operationId": "createEquipment",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EquipmentRequest"
}
}
}
}
}
},
"/equipment/{id}": {
"get": {
"summary": "Get Equipment item.",
"operationId": "getEquipmentItem",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Equipment item.",
"operationId": "updateEquipment",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EquipmentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/accessories": {
"get": {
"summary": "Get Accessory collection.",
"operationId": "getEquipmentAccessoryCollection",
"description": "Represents accessories of an equipment item. Each equipment can have multiple accessories. Accessories are equipment items themselves.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessoryResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Accessory item.",
"operationId": "createAccessory",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AccessoryResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessoryRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/alternatives": {
"get": {
"summary": "Get Alternative collection.",
"operationId": "getEquipmentAlternativeCollection",
"description": "Represents alternatives of an equipment item. Each equipment can have multiple alternatives. Alternatives are equipment items themselves.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AlternativeResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Alternative item.",
"operationId": "createAlternative",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AlternativeResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlternativeRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/equipmentsetscontent": {
"get": {
"summary": "Get EquipmentSetContent collection.",
"operationId": "getEquipmentEquipmentSetContentCollection",
"description": "With this endpoint, you can retrieve the contents of combinations together with their information.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EquipmentSetContentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create EquipmentSetContent item.",
"operationId": "createEquipmentSetContent",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EquipmentSetContentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EquipmentSetContentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getEquipmentFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getEquipmentFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/repairs": {
"get": {
"summary": "Get Repair collection.",
"operationId": "getEquipmentRepairCollection",
"description": "With this endpoint you can retrieve repairs and their information.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RepairResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/serialnumbers": {
"get": {
"summary": "Get SerialNumber collection.",
"operationId": "getEquipmentSerialNumberCollection",
"description": "Represents serial numbers, which are specific individual equipment pieces. This is a sub-item of Equipment and is always associated with a single Equipment item.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerialNumberResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create SerialNumber item.",
"operationId": "createSerialNumber",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SerialNumberResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerialNumberRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/stockmovements": {
"get": {
"summary": "Get StockMovement collection.",
"operationId": "getEquipmentStockMovementCollection",
"description": "Stock movements are all the changes that happen to the stock levels of an equipment. Those changes include manual changes, purchases, sales, transfers, stock corrections, repairs, marking lost or found, imports, stock counts. When creating or updating stock movements via the API only stock movements of type 'manual' are writable. Only stock movements for bulk items are available though the API. Stock movements for serialized equipment may be implemented at a later stage.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockMovementResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create StockMovement item.",
"operationId": "createStockMovement",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StockMovementResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/suppliers": {
"get": {
"summary": "Get Supplier collection.",
"operationId": "getEquipmentSupplierCollection",
"description": "Represents a supplier relationship between a contact and an equipment item. Each supplier entry links a contact to an equipment item, optionally with a purchase price and additional details.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SupplierResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Supplier item.",
"operationId": "createSupplier",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SupplierResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipment/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getEquipmentTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"equipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipmentassignedserials": {
"get": {
"summary": "Get EquipmentAssignedSerials collection.",
"operationId": "getEquipmentAssignedSerialsCollection",
"description": "With this endpoint, you can retrieve the serial numbers assigned to serialized physical combinations together with their information. This endpoint only returns serials which have been assigned manually from the serial numbers tab, not actual content. Please see this article for more information",
"tags": [
"equipmentassignedserials"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EquipmentAssignedSerialsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/equipmentassignedserials/{id}": {
"get": {
"summary": "Get EquipmentAssignedSerials item.",
"operationId": "getEquipmentAssignedSerialsItem",
"description": "",
"tags": [
"equipmentassignedserials"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EquipmentAssignedSerialsResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/equipmentsetscontent": {
"get": {
"summary": "Get EquipmentSetContent collection.",
"operationId": "getEquipmentSetContentCollection",
"description": "With this endpoint, you can retrieve the contents of combinations together with their information.",
"tags": [
"equipmentsetscontent"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EquipmentSetContentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/equipmentsetscontent/{id}": {
"get": {
"summary": "Get EquipmentSetContent item.",
"operationId": "getEquipmentSetContentItem",
"description": "",
"tags": [
"equipmentsetscontent"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EquipmentSetContentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update EquipmentSetContent item.",
"operationId": "updateEquipmentSetContent",
"description": "",
"tags": [
"equipmentsetscontent"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EquipmentSetContentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EquipmentSetContentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete EquipmentSetContent item.",
"operationId": "deleteEquipmentSetContent",
"description": "",
"tags": [
"equipmentsetscontent"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/extrainputfields": {
"get": {
"summary": "Get ExtraInputField collection.",
"operationId": "getExtraInputFieldCollection",
"description": "With this endpoint, you can read extra input fields.",
"tags": [
"extrainputfields"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraInputFieldResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/extrainputfields/{id}": {
"get": {
"summary": "Get ExtraInputField item.",
"operationId": "getExtraInputFieldItem",
"description": "",
"tags": [
"extrainputfields"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ExtraInputFieldResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/factorgroups": {
"get": {
"summary": "Get FactorGroups collection.",
"operationId": "getFactorGroupsCollection",
"description": "All factor groups.",
"tags": [
"factorgroups"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FactorGroupsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/factorgroups/{id}": {
"get": {
"summary": "Get FactorGroups item.",
"operationId": "getFactorGroupsItem",
"description": "",
"tags": [
"factorgroups"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FactorGroupsResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/factorgroups/{id}/factors": {
"get": {
"summary": "Get Factors collection.",
"operationId": "getFactorGroupsFactorsCollection",
"description": "All factor.",
"tags": [
"factorgroups"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FactorsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/factors": {
"get": {
"summary": "Get Factors collection.",
"operationId": "getFactorsCollection",
"description": "All factor.",
"tags": [
"factors"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FactorsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/factors/{id}": {
"get": {
"summary": "Get Factors item.",
"operationId": "getFactorsItem",
"description": "",
"tags": [
"factors"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FactorsResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"file_folders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/file_folders/{id}": {
"get": {
"summary": "Get FileFolder item.",
"operationId": "getFileFolderItem",
"description": "",
"tags": [
"file_folders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"files"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/files/{id}": {
"get": {
"summary": "Get File item.",
"operationId": "getFileItem",
"description": "",
"tags": [
"files"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FileResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/folders": {
"get": {
"summary": "Get Folder collection.",
"operationId": "getFolderCollection",
"description": "Contacts, equipment, crew, vehicles, containers, projecttemplates and default functions are organised into folders",
"tags": [
"folders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create Folder item.",
"operationId": "createFolder",
"description": "",
"tags": [
"folders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FolderResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderRequest"
}
}
}
}
}
},
"/folders/{id}": {
"get": {
"summary": "Get Folder item.",
"operationId": "getFolderItem",
"description": "",
"tags": [
"folders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FolderResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Folder item.",
"operationId": "updateFolder",
"description": "",
"tags": [
"folders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FolderResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/invitations": {
"get": {
"summary": "Get Invitations collection.",
"operationId": "getInvitationsCollection",
"description": "With this endpoint, you can read sent invitations for crew functions.",
"tags": [
"invitations"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvitationsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/invitations/{id}": {
"get": {
"summary": "Get Invitations item.",
"operationId": "getInvitationsItem",
"description": "",
"tags": [
"invitations"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InvitationsResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/invoicelines": {
"get": {
"summary": "Get InvoiceLine collection.",
"operationId": "getInvoiceLineCollection",
"description": "Invoice lines are generated lines based on tax rates and ledgers of the items within an invoice. They sum up to the total of the invoice. Useful for exporting to accounting systems. It is currently not possible to get the exact same details which are displayed on the invoice pdf, since that depends on the used document template.",
"tags": [
"invoicelines"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceLineResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/invoicelines/{id}": {
"get": {
"summary": "Get InvoiceLine item.",
"operationId": "getInvoiceLineItem",
"description": "",
"tags": [
"invoicelines"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InvoiceLineResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/invoices": {
"get": {
"summary": "Get Factuur collection.",
"operationId": "getFactuurCollection",
"description": "Represents invoices.",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FactuurResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/invoices/{id}": {
"get": {
"summary": "Get Factuur item.",
"operationId": "getFactuurItem",
"description": "",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/FactuurResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/invoices/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getFactuurFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/invoices/{id}/invoicelines": {
"get": {
"summary": "Get InvoiceLine collection.",
"operationId": "getFactuurInvoiceLineCollection",
"description": "Invoice lines are generated lines based on tax rates and ledgers of the items within an invoice. They sum up to the total of the invoice. Useful for exporting to accounting systems. It is currently not possible to get the exact same details which are displayed on the invoice pdf, since that depends on the used document template.",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceLineResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/invoices/{id}/payments": {
"get": {
"summary": "Get Payment collection.",
"operationId": "getFactuurPaymentCollection",
"description": "Represents payments.",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Payment item.",
"operationId": "createPayment",
"description": "",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PaymentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/invoices/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getFactuurTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"invoices"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/leavemutation": {
"get": {
"summary": "Get LeaveMutations collection.",
"operationId": "getLeaveMutationsCollection",
"description": "With this endpoint, you could work with leave mutations and their information.\n\nThese items are immutable, so any mistakes made in the mutations should be corrected by creating a new (opposite) mutation.\n\nDuration is expressed in seconds.",
"tags": [
"leavemutation"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveMutationsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create LeaveMutations item.",
"operationId": "createLeaveMutations",
"description": "",
"tags": [
"leavemutation"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LeaveMutationsResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LeaveMutationsRequest"
}
}
}
}
}
},
"/leavemutation/{id}": {
"get": {
"summary": "Get LeaveMutations item.",
"operationId": "getLeaveMutationsItem",
"description": "",
"tags": [
"leavemutation"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LeaveMutationsResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/leaverequest": {
"get": {
"summary": "Get LeaveRequest collection.",
"operationId": "getLeaveRequestCollection",
"description": "With this endpoint, you could work with leave requests and their information.\n\nMake sure to also create the corresponding request lines for this request (by using the `/leaverequest/:id/timeregistration` endpoint).\n\nThe leave type for the request lines must require approval (See `/leavetypes` endpoint for this information).\n\nHours requests can be updated as long as they are in status 'Pending', once they get Approved/Rejected they can't be updated anymore besides transitioning a request from Approved to Cancelled.\n\nOnce created, the crew member the request is for can't be updated.",
"tags": [
"leaverequest"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveRequestResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create LeaveRequest item.",
"operationId": "createLeaveRequest",
"description": "",
"tags": [
"leaverequest"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LeaveRequestResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LeaveRequestRequest"
}
}
}
}
}
},
"/leaverequest/{id}": {
"get": {
"summary": "Get LeaveRequest item.",
"operationId": "getLeaveRequestItem",
"description": "",
"tags": [
"leaverequest"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LeaveRequestResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update LeaveRequest item.",
"operationId": "updateLeaveRequest",
"description": "",
"tags": [
"leaverequest"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LeaveRequestResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LeaveRequestRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/leaverequest/{id}/timeregistration": {
"get": {
"summary": "Get TimeRegistration collection.",
"operationId": "getLeaveRequestTimeRegistrationCollection",
"description": "With this endpoint, you could retrieve time registrations and their information.",
"tags": [
"leaverequest"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeRegistrationResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create TimeRegistration item.",
"operationId": "createTimeRegistration",
"description": "",
"tags": [
"leaverequest"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimeRegistrationResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeRegistrationRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/leavetypes": {
"get": {
"summary": "Get LeaveTypes collection.",
"operationId": "getLeaveTypesCollection",
"description": "With this endpoint, you could work with leave types and their information.",
"tags": [
"leavetypes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LeaveTypesResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/leavetypes/{id}": {
"get": {
"summary": "Get LeaveTypes item.",
"operationId": "getLeaveTypesItem",
"description": "",
"tags": [
"leavetypes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LeaveTypesResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/ledgercodes": {
"get": {
"summary": "Get Ledger collection.",
"operationId": "getLedgerCollection",
"description": "Ledger codes are the codes defining the type of trade for an invoice line.",
"tags": [
"ledgercodes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LedgerResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/ledgercodes/{id}": {
"get": {
"summary": "Get Ledger item.",
"operationId": "getLedgerItem",
"description": "",
"tags": [
"ledgercodes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LedgerResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/payments": {
"get": {
"summary": "Get Payment collection.",
"operationId": "getPaymentCollection",
"description": "Represents payments.",
"tags": [
"payments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/payments/{id}": {
"get": {
"summary": "Get Payment item.",
"operationId": "getPaymentItem",
"description": "",
"tags": [
"payments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PaymentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Payment item.",
"operationId": "updatePayment",
"description": "",
"tags": [
"payments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PaymentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectcrew": {
"get": {
"summary": "Get ProjectCrew collection.",
"operationId": "getProjectCrewCollection",
"description": "Represents the planning of crewmembers on Functions",
"tags": [
"projectcrew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCrewResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectcrew/{id}": {
"get": {
"summary": "Get ProjectCrew item.",
"operationId": "getProjectCrewItem",
"description": "",
"tags": [
"projectcrew"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectCrewResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectequipment": {
"get": {
"summary": "Get ProjectEquipment collection.",
"operationId": "getProjectEquipmentCollection",
"description": "Represents equipment items planned in a project.",
"tags": [
"projectequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectequipment/{id}": {
"get": {
"summary": "Get ProjectEquipment item.",
"operationId": "getProjectEquipmentItem",
"description": "",
"tags": [
"projectequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectEquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectequipmentgroup": {
"get": {
"summary": "Get ProjectEquipmentGroup collection.",
"operationId": "getProjectEquipmentGroupCollection",
"description": "Equipment groups of a project.",
"tags": [
"projectequipmentgroup"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectEquipmentGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectequipmentgroup/{id}": {
"get": {
"summary": "Get ProjectEquipmentGroup item.",
"operationId": "getProjectEquipmentGroupItem",
"description": "",
"tags": [
"projectequipmentgroup"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectEquipmentGroupResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectequipmentgroup/{id}/projectequipment": {
"get": {
"summary": "Get ProjectEquipment collection.",
"operationId": "getProjectEquipmentGroupProjectEquipmentCollection",
"description": "Represents equipment items planned in a project.",
"tags": [
"projectequipmentgroup"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectfunctiongroups": {
"get": {
"summary": "Get ProjectFunctionGroup collection.",
"operationId": "getProjectFunctionGroupCollection",
"description": "Function groups inside a project",
"tags": [
"projectfunctiongroups"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectFunctionGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectfunctiongroups/{id}": {
"get": {
"summary": "Get ProjectFunctionGroup item.",
"operationId": "getProjectFunctionGroupItem",
"description": "",
"tags": [
"projectfunctiongroups"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectFunctionGroupResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectfunctiongroups/{id}/projectfunctions": {
"get": {
"summary": "Get ProjectFunction collection.",
"operationId": "getProjectFunctionGroupProjectFunctionCollection",
"description": "A function is a task that needs to be performed. Functions are connected to subprojects (and projects). Functions can be grouped inside function groups.",
"tags": [
"projectfunctiongroups"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectFunctionResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectfunctions": {
"get": {
"summary": "Get ProjectFunction collection.",
"operationId": "getProjectFunctionCollection",
"description": "A function is a task that needs to be performed. Functions are connected to subprojects (and projects). Functions can be grouped inside function groups.",
"tags": [
"projectfunctions"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectFunctionResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectfunctions/{id}": {
"get": {
"summary": "Get ProjectFunction item.",
"operationId": "getProjectFunctionItem",
"description": "",
"tags": [
"projectfunctions"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectFunctionResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectfunctions/{id}/projectcrew": {
"get": {
"summary": "Get ProjectCrew collection.",
"operationId": "getProjectFunctionProjectCrewCollection",
"description": "Represents the planning of crewmembers on Functions",
"tags": [
"projectfunctions"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCrewResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectfunctions/{id}/projectvehicles": {
"get": {
"summary": "Get ProjectVehicle collection.",
"operationId": "getProjectFunctionProjectVehicleCollection",
"description": "Represents the vehicles planned for a function.",
"tags": [
"projectfunctions"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectVehicleResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectrequestequipment": {
"get": {
"summary": "Get ProjectRequestEquipment collection.",
"operationId": "getProjectRequestEquipmentCollection",
"description": "Project Request Equipment are equipment items linked to the Project Request. You can use this to add equipment items in a raw data format to the Project Request. The equipment items will be matched to the existing equipment items in the account when converting the Project Request into a Project in the Rentman interface.",
"tags": [
"projectrequestequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectRequestEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectrequestequipment/{id}": {
"get": {
"summary": "Get ProjectRequestEquipment item.",
"operationId": "getProjectRequestEquipmentItem",
"description": "",
"tags": [
"projectrequestequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequestEquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update ProjectRequestEquipment item.",
"operationId": "updateProjectRequestEquipment",
"description": "",
"tags": [
"projectrequestequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequestEquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRequestEquipmentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete ProjectRequestEquipment item.",
"operationId": "deleteProjectRequestEquipment",
"description": "",
"tags": [
"projectrequestequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectrequests": {
"get": {
"summary": "Get ProjectRequest collection.",
"operationId": "getProjectRequestCollection",
"description": "Project Requests are incoming requests from external sources that allows you to turn into projects. These could come from another Rentman user, that is using the internal subrent request feature. By making also the POST endpoint available in the API, you can now also push these from other applications. For example from your CRM system, a form on your website, or any other source. The benefit of using Project Requests is that you can provide the data in a raw format. While converting a Project Request into a project from the Rentman interface, you can match this data to existing contacts, equipments etc. No need to set up complicated logic to fetch these items using the API first.",
"tags": [
"projectrequests"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectRequestResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create ProjectRequest item.",
"operationId": "createProjectRequest",
"description": "",
"tags": [
"projectrequests"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequestResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRequestRequest"
}
}
}
}
}
},
"/projectrequests/{id}": {
"get": {
"summary": "Get ProjectRequest item.",
"operationId": "getProjectRequestItem",
"description": "",
"tags": [
"projectrequests"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequestResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update ProjectRequest item.",
"operationId": "updateProjectRequest",
"description": "",
"tags": [
"projectrequests"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequestResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRequestRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete ProjectRequest item.",
"operationId": "deleteProjectRequest",
"description": "",
"tags": [
"projectrequests"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectrequests/{id}/projectrequestequipment": {
"get": {
"summary": "Get ProjectRequestEquipment collection.",
"operationId": "getProjectRequestProjectRequestEquipmentCollection",
"description": "Project Request Equipment are equipment items linked to the Project Request. You can use this to add equipment items in a raw data format to the Project Request. The equipment items will be matched to the existing equipment items in the account when converting the Project Request into a Project in the Rentman interface.",
"tags": [
"projectrequests"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectRequestEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create ProjectRequestEquipment item.",
"operationId": "createProjectRequestEquipment",
"description": "",
"tags": [
"projectrequests"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequestEquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRequestEquipmentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects": {
"get": {
"summary": "Get Project collection.",
"operationId": "getProjectCollection",
"description": "Projects are the cornerstone of Rentman. Projects are connected to many other items. Projects always include one or more subprojects. When the user interface does not show any subprojects there is in fact a single one. See the /subprojects endpoint for more information.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create Project item.",
"operationId": "createProject",
"description": "",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRequest"
}
}
}
}
}
},
"/projects/{id}": {
"get": {
"summary": "Get Project item.",
"operationId": "getProjectItem",
"description": "",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/contracts": {
"get": {
"summary": "Get Contract collection.",
"operationId": "getProjectContractCollection",
"description": "Represents contracts.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContractResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/costs": {
"get": {
"summary": "Get ProjectCost collection.",
"operationId": "getProjectProjectCostCollection",
"description": "Represents additional costs in a project.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCostResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create ProjectCost item.",
"operationId": "createProjectCost",
"description": "",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectCostResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCostRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getProjectFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getProjectFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/projectcrew": {
"get": {
"summary": "Get ProjectCrew collection.",
"operationId": "getProjectProjectCrewCollection",
"description": "Represents the planning of crewmembers on Functions",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCrewResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/projectequipment": {
"get": {
"summary": "Get ProjectEquipment collection.",
"operationId": "getProjectProjectEquipmentCollection",
"description": "Represents equipment items planned in a project.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/projectequipmentgroup": {
"get": {
"summary": "Get ProjectEquipmentGroup collection.",
"operationId": "getProjectProjectEquipmentGroupCollection",
"description": "Equipment groups of a project.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectEquipmentGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/projectfunctiongroups": {
"get": {
"summary": "Get ProjectFunctionGroup collection.",
"operationId": "getProjectProjectFunctionGroupCollection",
"description": "Function groups inside a project",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectFunctionGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create ProjectFunctionGroup item.",
"operationId": "createProjectFunctionGroup",
"description": "",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectFunctionGroupResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectFunctionGroupRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/projectfunctions": {
"get": {
"summary": "Get ProjectFunction collection.",
"operationId": "getProjectProjectFunctionCollection",
"description": "A function is a task that needs to be performed. Functions are connected to subprojects (and projects). Functions can be grouped inside function groups.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectFunctionResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create ProjectFunction item.",
"operationId": "createProjectFunction",
"description": "",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectFunctionResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectFunctionRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/projectvehicles": {
"get": {
"summary": "Get ProjectVehicle collection.",
"operationId": "getProjectProjectVehicleCollection",
"description": "Represents the vehicles planned for a function.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectVehicleResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/quotes": {
"get": {
"summary": "Get Quotation collection.",
"operationId": "getProjectQuotationCollection",
"description": "Represents quotes.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuotationResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/subprojects": {
"get": {
"summary": "Get Subproject collection.",
"operationId": "getProjectSubprojectCollection",
"description": "Subprojects are part of projects. All projects include at least one subproject. Information that differs from subproject to subproject, e.g. location, is retrieved in this endpoint.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubprojectResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Subproject item.",
"operationId": "createSubproject",
"description": "",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubprojectResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubprojectRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projects/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getProjectTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"projects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectstatuses": {
"get": {
"summary": "Get ProjectStatus collection.",
"operationId": "getProjectStatusCollection",
"description": "Get project status objects",
"tags": [
"projectstatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectStatusResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectstatuses/{id}": {
"get": {
"summary": "Get ProjectStatus item.",
"operationId": "getProjectStatusItem",
"description": "",
"tags": [
"projectstatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectStatusResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projecttypes": {
"get": {
"summary": "Get ProjectType collection.",
"operationId": "getProjectTypeCollection",
"description": "Get a specific project type.",
"tags": [
"projecttypes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectTypeResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projecttypes/{id}": {
"get": {
"summary": "Get ProjectType item.",
"operationId": "getProjectTypeItem",
"description": "",
"tags": [
"projecttypes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectTypeResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/projectvehicles": {
"get": {
"summary": "Get ProjectVehicle collection.",
"operationId": "getProjectVehicleCollection",
"description": "Represents the vehicles planned for a function.",
"tags": [
"projectvehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectVehicleResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/projectvehicles/{id}": {
"get": {
"summary": "Get ProjectVehicle item.",
"operationId": "getProjectVehicleItem",
"description": "",
"tags": [
"projectvehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectVehicleResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseordercosts": {
"get": {
"summary": "Get PurchaseOrderCost collection.",
"operationId": "getPurchaseOrderCostCollection",
"description": "Represents line items within a purchase order.",
"tags": [
"purchaseordercosts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderCostResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/purchaseordercosts/{id}": {
"get": {
"summary": "Get PurchaseOrderCost item.",
"operationId": "getPurchaseOrderCostItem",
"description": "",
"tags": [
"purchaseordercosts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PurchaseOrderCostResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorderglobalcosts": {
"get": {
"summary": "Get PurchaseOrderGlobalCost collection.",
"operationId": "getPurchaseOrderGlobalCostCollection",
"description": "Represents global costs of a purchase order.",
"tags": [
"purchaseorderglobalcosts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderGlobalCostResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/purchaseorderglobalcosts/{id}": {
"get": {
"summary": "Get PurchaseOrderGlobalCost item.",
"operationId": "getPurchaseOrderGlobalCostItem",
"description": "",
"tags": [
"purchaseorderglobalcosts"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PurchaseOrderGlobalCostResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorders": {
"get": {
"summary": "Get PurchaseOrder collection.",
"operationId": "getPurchaseOrderCollection",
"description": "Represents purchase orders.",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/purchaseorders/{id}": {
"get": {
"summary": "Get PurchaseOrder item.",
"operationId": "getPurchaseOrderItem",
"description": "",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PurchaseOrderResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorders/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getPurchaseOrderFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorders/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getPurchaseOrderFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorders/{id}/invoicelines": {
"get": {
"summary": "Get InvoiceLine collection.",
"operationId": "getPurchaseOrderInvoiceLineCollection",
"description": "Invoice lines are generated lines based on tax rates and ledgers of the items within an invoice. They sum up to the total of the invoice. Useful for exporting to accounting systems. It is currently not possible to get the exact same details which are displayed on the invoice pdf, since that depends on the used document template.",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceLineResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorders/{id}/purchaseordercosts": {
"get": {
"summary": "Get PurchaseOrderCost collection.",
"operationId": "getPurchaseOrderPurchaseOrderCostCollection",
"description": "Represents line items within a purchase order.",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderCostResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorders/{id}/purchaseorderglobalcosts": {
"get": {
"summary": "Get PurchaseOrderGlobalCost collection.",
"operationId": "getPurchaseOrderPurchaseOrderGlobalCostCollection",
"description": "Represents global costs of a purchase order.",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurchaseOrderGlobalCostResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/purchaseorders/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getPurchaseOrderTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"purchaseorders"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/quotes": {
"get": {
"summary": "Get Quotation collection.",
"operationId": "getQuotationCollection",
"description": "Represents quotes.",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuotationResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/quotes/{id}": {
"get": {
"summary": "Get Quotation item.",
"operationId": "getQuotationItem",
"description": "",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/QuotationResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/quotes/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getQuotationFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/quotes/{id}/invoicelines": {
"get": {
"summary": "Get InvoiceLine collection.",
"operationId": "getQuotationInvoiceLineCollection",
"description": "Invoice lines are generated lines based on tax rates and ledgers of the items within an invoice. They sum up to the total of the invoice. Useful for exporting to accounting systems. It is currently not possible to get the exact same details which are displayed on the invoice pdf, since that depends on the used document template.",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceLineResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/quotes/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getQuotationTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"quotes"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/ratefactors": {
"get": {
"summary": "Get CrewRateFactor collection.",
"operationId": "getCrewRateFactorCollection",
"description": "Represents the rate factors for the crew rates.",
"tags": [
"ratefactors"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewRateFactorResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/ratefactors/{id}": {
"get": {
"summary": "Get CrewRateFactor item.",
"operationId": "getCrewRateFactorItem",
"description": "",
"tags": [
"ratefactors"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CrewRateFactorResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/rates": {
"get": {
"summary": "Get CrewRate collection.",
"operationId": "getCrewRateCollection",
"description": "Represents crew rates.",
"tags": [
"rates"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewRateResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/rates/{id}": {
"get": {
"summary": "Get CrewRate item.",
"operationId": "getCrewRateItem",
"description": "",
"tags": [
"rates"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CrewRateResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/rates/{id}/ratefactors": {
"get": {
"summary": "Get CrewRateFactor collection.",
"operationId": "getCrewRateCrewRateFactorCollection",
"description": "Represents the rate factors for the crew rates.",
"tags": [
"rates"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrewRateFactorResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/repairs": {
"get": {
"summary": "Get Repair collection.",
"operationId": "getRepairCollection",
"description": "With this endpoint you can retrieve repairs and their information.",
"tags": [
"repairs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RepairResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/repairs/{id}": {
"get": {
"summary": "Get Repair item.",
"operationId": "getRepairItem",
"description": "",
"tags": [
"repairs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RepairResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/repairs/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getRepairFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"repairs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/repairs/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getRepairFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"repairs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/repairs/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getRepairTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"repairs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"repairs"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/serialnumbers": {
"get": {
"summary": "Get SerialNumber collection.",
"operationId": "getSerialNumberCollection",
"description": "Represents serial numbers, which are specific individual equipment pieces. This is a sub-item of Equipment and is always associated with a single Equipment item.",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerialNumberResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/serialnumbers/{id}": {
"get": {
"summary": "Get SerialNumber item.",
"operationId": "getSerialNumberItem",
"description": "",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SerialNumberResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update SerialNumber item.",
"operationId": "updateSerialNumber",
"description": "",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SerialNumberResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerialNumberRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete SerialNumber item.",
"operationId": "deleteSerialNumber",
"description": "",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/serialnumbers/{id}/actualcontent": {
"get": {
"summary": "Get ActualContent collection.",
"operationId": "getSerialNumberActualContentCollection",
"description": "Represents the actual content of serialized physical combinations",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActualContentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/serialnumbers/{id}/equipmentassignedserials": {
"get": {
"summary": "Get EquipmentAssignedSerials collection.",
"operationId": "getSerialNumberEquipmentAssignedSerialsCollection",
"description": "With this endpoint, you can retrieve the serial numbers assigned to serialized physical combinations together with their information. This endpoint only returns serials which have been assigned manually from the serial numbers tab, not actual content. Please see this article for more information",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EquipmentAssignedSerialsResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/serialnumbers/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getSerialNumberFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/serialnumbers/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getSerialNumberFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/serialnumbers/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getSerialNumberTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"serialnumbers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/statuses": {
"get": {
"summary": "Get Status collection.",
"operationId": "getStatusCollection",
"description": "Get a status objects",
"tags": [
"statuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/statuses/{id}": {
"get": {
"summary": "Get Status item.",
"operationId": "getStatusItem",
"description": "",
"tags": [
"statuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StatusResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/stocklocations": {
"get": {
"summary": "Get StockLocation collection.",
"operationId": "getStockLocationCollection",
"description": "With this endpoint, you can retrieve the stock locations and their information.",
"tags": [
"stocklocations"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockLocationResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/stocklocations/{id}": {
"get": {
"summary": "Get StockLocation item.",
"operationId": "getStockLocationItem",
"description": "",
"tags": [
"stocklocations"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StockLocationResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/stocklocations/{id}/vehicles": {
"get": {
"summary": "Get Vehicle collection.",
"operationId": "getStockLocationVehicleCollection",
"description": "Represents vehicles.",
"tags": [
"stocklocations"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VehicleResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Vehicle item.",
"operationId": "createVehicle",
"description": "",
"tags": [
"stocklocations"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VehicleResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VehicleRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/stockmovements": {
"get": {
"summary": "Get StockMovement collection.",
"operationId": "getStockMovementCollection",
"description": "Stock movements are all the changes that happen to the stock levels of an equipment. Those changes include manual changes, purchases, sales, transfers, stock corrections, repairs, marking lost or found, imports, stock counts. When creating or updating stock movements via the API only stock movements of type 'manual' are writable. Only stock movements for bulk items are available though the API. Stock movements for serialized equipment may be implemented at a later stage.",
"tags": [
"stockmovements"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockMovementResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/stockmovements/{id}": {
"get": {
"summary": "Get StockMovement item.",
"operationId": "getStockMovementItem",
"description": "",
"tags": [
"stockmovements"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StockMovementResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update StockMovement item.",
"operationId": "updateStockMovement",
"description": "",
"tags": [
"stockmovements"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StockMovementResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockMovementRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete StockMovement item.",
"operationId": "deleteStockMovement",
"description": "",
"tags": [
"stockmovements"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subprojects": {
"get": {
"summary": "Get Subproject collection.",
"operationId": "getSubprojectCollection",
"description": "Subprojects are part of projects. All projects include at least one subproject. Information that differs from subproject to subproject, e.g. location, is retrieved in this endpoint.",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubprojectResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/subprojects/{id}": {
"get": {
"summary": "Get Subproject item.",
"operationId": "getSubprojectItem",
"description": "",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubprojectResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subprojects/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getSubprojectFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subprojects/{id}/projectcrew": {
"get": {
"summary": "Get ProjectCrew collection.",
"operationId": "getSubprojectProjectCrewCollection",
"description": "Represents the planning of crewmembers on Functions",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCrewResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subprojects/{id}/projectequipment": {
"get": {
"summary": "Get ProjectEquipment collection.",
"operationId": "getSubprojectProjectEquipmentCollection",
"description": "Represents equipment items planned in a project.",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subprojects/{id}/projectequipmentgroup": {
"get": {
"summary": "Get ProjectEquipmentGroup collection.",
"operationId": "getSubprojectProjectEquipmentGroupCollection",
"description": "Equipment groups of a project.",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectEquipmentGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subprojects/{id}/projectfunctiongroups": {
"get": {
"summary": "Get ProjectFunctionGroup collection.",
"operationId": "getSubprojectProjectFunctionGroupCollection",
"description": "Function groups inside a project",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectFunctionGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subprojects/{id}/projectvehicles": {
"get": {
"summary": "Get ProjectVehicle collection.",
"operationId": "getSubprojectProjectVehicleCollection",
"description": "Represents the vehicles planned for a function.",
"tags": [
"subprojects"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectVehicleResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentalequipment": {
"get": {
"summary": "Get SubrentalEquipment collection.",
"operationId": "getSubrentalEquipmentCollection",
"description": "With this endpoint you can retrieve information about subrental equipment.",
"tags": [
"subrentalequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubrentalEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/subrentalequipment/{id}": {
"get": {
"summary": "Get SubrentalEquipment item.",
"operationId": "getSubrentalEquipmentItem",
"description": "",
"tags": [
"subrentalequipment"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubrentalEquipmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentalequipmentgroup": {
"get": {
"summary": "Get SubrentalEquipmentGroup collection.",
"operationId": "getSubrentalEquipmentGroupCollection",
"description": "With this endpoint you can retrieve information about subrental equipment groups.",
"tags": [
"subrentalequipmentgroup"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubrentalEquipmentGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/subrentalequipmentgroup/{id}": {
"get": {
"summary": "Get SubrentalEquipmentGroup item.",
"operationId": "getSubrentalEquipmentGroupItem",
"description": "",
"tags": [
"subrentalequipmentgroup"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubrentalEquipmentGroupResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentalequipmentgroup/{id}/subrentalequipment": {
"get": {
"summary": "Get SubrentalEquipment collection.",
"operationId": "getSubrentalEquipmentGroupSubrentalEquipmentCollection",
"description": "With this endpoint you can retrieve information about subrental equipment.",
"tags": [
"subrentalequipmentgroup"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubrentalEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentals": {
"get": {
"summary": "Get Subrental collection.",
"operationId": "getSubrentalCollection",
"description": "With this endpoint you can retrieve subrentals and their information.",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubrentalResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/subrentals/{id}": {
"get": {
"summary": "Get Subrental item.",
"operationId": "getSubrentalItem",
"description": "",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubrentalResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentals/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getSubrentalFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentals/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getSubrentalFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentals/{id}/subrentalequipment": {
"get": {
"summary": "Get SubrentalEquipment collection.",
"operationId": "getSubrentalSubrentalEquipmentCollection",
"description": "With this endpoint you can retrieve information about subrental equipment.",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubrentalEquipmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentals/{id}/subrentalequipmentgroup": {
"get": {
"summary": "Get SubrentalEquipmentGroup collection.",
"operationId": "getSubrentalSubrentalEquipmentGroupCollection",
"description": "With this endpoint you can retrieve information about subrental equipment groups.",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubrentalEquipmentGroupResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subrentals/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getSubrentalTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"subrentals"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/subtasks": {
"get": {
"summary": "Get Subtask collection.",
"operationId": "getSubtaskCollection",
"description": "With this endpoint, you can read, write, update and delete subtasks.",
"tags": [
"subtasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubtaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/subtasks/{id}": {
"get": {
"summary": "Get Subtask item.",
"operationId": "getSubtaskItem",
"description": "",
"tags": [
"subtasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubtaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Subtask item.",
"operationId": "updateSubtask",
"description": "",
"tags": [
"subtasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubtaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubtaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Subtask item.",
"operationId": "deleteSubtask",
"description": "",
"tags": [
"subtasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/suppliers": {
"get": {
"summary": "Get Supplier collection.",
"operationId": "getSupplierCollection",
"description": "Represents a supplier relationship between a contact and an equipment item. Each supplier entry links a contact to an equipment item, optionally with a purchase price and additional details.",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SupplierResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/suppliers/{id}": {
"get": {
"summary": "Get Supplier item.",
"operationId": "getSupplierItem",
"description": "",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SupplierResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Supplier item.",
"operationId": "updateSupplier",
"description": "",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SupplierResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplierRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Supplier item.",
"operationId": "deleteSupplier",
"description": "",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/suppliers/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getSupplierFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/suppliers/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getSupplierFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/suppliers/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getSupplierTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"suppliers"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/taskassignments": {
"get": {
"summary": "Get TaskAssignment collection.",
"operationId": "getTaskAssignmentCollection",
"description": "With this endpoint, you can read, write, update and delete task assignments.",
"tags": [
"taskassignments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskAssignmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/taskassignments/{id}": {
"get": {
"summary": "Get TaskAssignment item.",
"operationId": "getTaskAssignmentItem",
"description": "",
"tags": [
"taskassignments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskAssignmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update TaskAssignment item.",
"operationId": "updateTaskAssignment",
"description": "",
"tags": [
"taskassignments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskAssignmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAssignmentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete TaskAssignment item.",
"operationId": "deleteTaskAssignment",
"description": "",
"tags": [
"taskassignments"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
}
}
},
"/tasks/{id}": {
"get": {
"summary": "Get Task item.",
"operationId": "getTaskItem",
"description": "",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Task item.",
"operationId": "updateTask",
"description": "",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Task item.",
"operationId": "deleteTask",
"description": "",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/tasks/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getTaskFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/tasks/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getTaskFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/tasks/{id}/subtasks": {
"get": {
"summary": "Get Subtask collection.",
"operationId": "getTaskSubtaskCollection",
"description": "With this endpoint, you can read, write, update and delete subtasks.",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubtaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Subtask item.",
"operationId": "createSubtask",
"description": "",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SubtaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubtaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/tasks/{id}/taskassignments": {
"get": {
"summary": "Get TaskAssignment collection.",
"operationId": "getTaskTaskAssignmentCollection",
"description": "With this endpoint, you can read, write, update and delete task assignments.",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskAssignmentResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create TaskAssignment item.",
"operationId": "createTaskAssignment",
"description": "",
"tags": [
"tasks"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskAssignmentResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAssignmentRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/taskstatuses": {
"get": {
"summary": "Get TaskStatus collection.",
"operationId": "getTaskStatusCollection",
"description": "With this endpoint, you can read, write, update and delete task statuses.",
"tags": [
"taskstatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskStatusResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create TaskStatus item.",
"operationId": "createTaskStatus",
"description": "",
"tags": [
"taskstatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskStatusResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStatusRequest"
}
}
}
}
}
},
"/taskstatuses/{id}": {
"get": {
"summary": "Get TaskStatus item.",
"operationId": "getTaskStatusItem",
"description": "",
"tags": [
"taskstatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskStatusResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update TaskStatus item.",
"operationId": "updateTaskStatus",
"description": "",
"tags": [
"taskstatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskStatusResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStatusRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete TaskStatus item.",
"operationId": "deleteTaskStatus",
"description": "",
"tags": [
"taskstatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/taxclasses": {
"get": {
"summary": "Get TaxClass collection.",
"operationId": "getTaxClassCollection",
"description": "Represents tax classes, which can be used to configure taxation rates.",
"tags": [
"taxclasses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxClassResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/taxclasses/{id}": {
"get": {
"summary": "Get TaxClass item.",
"operationId": "getTaxClassItem",
"description": "",
"tags": [
"taxclasses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaxClassResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/timeregistration": {
"get": {
"summary": "Get TimeRegistration collection.",
"operationId": "getTimeRegistrationCollection",
"description": "With this endpoint, you could retrieve time registrations and their information.",
"tags": [
"timeregistration"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeRegistrationResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create TimeRegistration item.",
"operationId": "createTimeRegistration",
"description": "",
"tags": [
"timeregistration"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimeRegistrationResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeRegistrationRequest"
}
}
}
}
}
},
"/timeregistration/{id}": {
"get": {
"summary": "Get TimeRegistration item.",
"operationId": "getTimeRegistrationItem",
"description": "",
"tags": [
"timeregistration"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimeRegistrationResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update TimeRegistration item.",
"operationId": "updateTimeRegistration",
"description": "",
"tags": [
"timeregistration"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimeRegistrationResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeRegistrationRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete TimeRegistration item.",
"operationId": "deleteTimeRegistration",
"description": "",
"tags": [
"timeregistration"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/timeregistration/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getTimeRegistrationFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"timeregistration"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/timeregistration/{id}/timeregistrationactivities": {
"get": {
"summary": "Get TimeRegistrationActivity collection.",
"operationId": "getTimeRegistrationTimeRegistrationActivityCollection",
"description": "With this endpoint, you could retrieve the activities of the time registrations and their information.",
"tags": [
"timeregistration"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeRegistrationActivityResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/timeregistrationactivities": {
"get": {
"summary": "Get TimeRegistrationActivity collection.",
"operationId": "getTimeRegistrationActivityCollection",
"description": "With this endpoint, you could retrieve the activities of the time registrations and their information.",
"tags": [
"timeregistrationactivities"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeRegistrationActivityResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/timeregistrationactivities/{id}": {
"get": {
"summary": "Get TimeRegistrationActivity item.",
"operationId": "getTimeRegistrationActivityItem",
"description": "",
"tags": [
"timeregistrationactivities"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimeRegistrationActivityResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/vehicles": {
"get": {
"summary": "Get Vehicle collection.",
"operationId": "getVehicleCollection",
"description": "Represents vehicles.",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VehicleResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
},
"post": {
"summary": "Create Vehicle item.",
"operationId": "createVehicle",
"description": "",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VehicleResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VehicleRequest"
}
}
}
}
}
},
"/vehicles/{id}": {
"get": {
"summary": "Get Vehicle item.",
"operationId": "getVehicleItem",
"description": "",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VehicleResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"put": {
"summary": "Update Vehicle item.",
"operationId": "updateVehicle",
"description": "",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VehicleResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VehicleRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"delete": {
"summary": "Delete Vehicle item.",
"operationId": "deleteVehicle",
"description": "",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"type": "null"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/vehicles/{id}/file_folders": {
"get": {
"summary": "Get FileFolder collection.",
"operationId": "getVehicleFileFolderCollection",
"description": "This endpoint exposes the folders that files can be in. A file folder is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileFolderResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/vehicles/{id}/files": {
"get": {
"summary": "Get File collection.",
"operationId": "getVehicleFileCollection",
"description": "All user-generated documents and uploaded files are available in this endpoint. Files are always linked to at least one other item. There are two types of links. The `file_item` and `file_itemtype` describe the item where the file originates from, for example a quotation or an import. If a file is attached in the user interface to another item, e.g. a project or an equipment item, this is done using the `item` and `itemtype` field.",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/vehicles/{id}/tasks": {
"get": {
"summary": "Get Task collection.",
"operationId": "getVehicleTaskCollection",
"description": "With this endpoint, you can read, write, update and delete tasks.",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
},
"post": {
"summary": "Create Task item.",
"operationId": "createTask",
"description": "",
"tags": [
"vehicles"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
},
"/warehousestatuses": {
"get": {
"summary": "Get WarehouseStatus collection.",
"operationId": "getWarehouseStatusCollection",
"description": "Get warehouse status objects",
"tags": [
"warehousestatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarehouseStatusResponse"
}
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
}
}
},
"/warehousestatuses/{id}": {
"get": {
"summary": "Get WarehouseStatus item.",
"operationId": "getWarehouseStatusItem",
"description": "",
"tags": [
"warehousestatuses"
],
"responses": {
"200": {
"description": "Successful request (note that the 'data' field can be expanded)",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WarehouseStatusResponse"
}
}
},
{
"$ref": "#/components/schemas/ApiResponse"
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Something went wrong"
},
"502": {
"description": "Bad gateway"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "Numeric ID of the itemtype",
"schema": {
"type": "integer"
}
}
]
}
}
},
"components": {
"schemas": {
"ApiResponse": {
"type": "object",
"description": "Response object",
"properties": {
"itemCount": {
"type": "integer",
"description": "The amount of items in the data"
},
"limit": {
"type": "integer",
"description": "The maximum amount of items that can be in data"
},
"offset": {
"type": "integer",
"description": "The amount of items skipped in data"
},
"next_page_url": {
"type": [
"string",
"null"
],
"description": "URL to the next page of results when using cursor-based pagination. Includes all original query parameters with cursor_after updated. Null when there are no more results. Only present when using cursor_limit."
}
}
},
"AccessoryRequest": {
"type": "object",
"required": [],
"properties": {
"equipment": {
"type": [
"string",
"null"
],
"description": "The equipment that is represented by this accessory.",
"example": "/equipment/0"
},
"quantity": {
"type": "integer",
"description": ""
},
"automatic": {
"type": "boolean",
"description": "Automatically add the accessory as soon as the equipment is added to the project."
},
"skip": {
"type": "boolean",
"description": "Do not add again if this accessory is already present in the project."
},
"is_free": {
"type": "boolean",
"description": "Adding the accessory to the project with zero as price."
},
"order": {
"type": "string",
"description": ""
},
"add_as_new_line": {
"type": "boolean",
"description": "The accessory is always added as a new line in the project as opposed to merging with the same accessory."
}
}
},
"AccessoryResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"parent_equipment",
"equipment",
"quantity",
"automatic",
"skip",
"is_free",
"order",
"add_as_new_line"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"parent_equipment": {
"type": "string",
"description": "The equipment that this item is an accessory of.",
"example": "/equipment/0"
},
"equipment": {
"type": [
"string",
"null"
],
"description": "The equipment that is represented by this accessory.",
"example": "/equipment/0"
},
"quantity": {
"type": "integer",
"description": ""
},
"automatic": {
"type": "boolean",
"description": "Automatically add the accessory as soon as the equipment is added to the project."
},
"skip": {
"type": "boolean",
"description": "Do not add again if this accessory is already present in the project."
},
"is_free": {
"type": "boolean",
"description": "Adding the accessory to the project with zero as price."
},
"order": {
"type": "string",
"description": ""
},
"add_as_new_line": {
"type": "boolean",
"description": "The accessory is always added as a new line in the project as opposed to merging with the same accessory."
}
}
},
"ActualContentRequest": {
"type": "object",
"required": [],
"properties": {
"equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"serial": {
"type": [
"string",
"null"
],
"description": "",
"example": "/serialnumbers/0"
},
"quantity": {
"type": "string",
"description": ""
}
}
},
"ActualContentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"equipment",
"serial",
"quantity",
"combination_serial"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"serial": {
"type": [
"string",
"null"
],
"description": "",
"example": "/serialnumbers/0"
},
"quantity": {
"type": "string",
"description": ""
},
"combination_serial": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD. The combination that contains this equipment.",
"example": "/serialnumbers/0"
}
}
},
"AlternativeRequest": {
"type": "object",
"required": [
"alternative"
],
"properties": {
"alternative": {
"type": "string",
"description": "",
"example": "/equipment/0"
}
}
},
"AlternativeResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"equipment",
"alternative"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"alternative": {
"type": "string",
"description": "",
"example": "/equipment/0"
}
}
},
"AppointmentCrewRequest": {
"type": "object",
"required": [
"crew"
],
"properties": {
"crew": {
"type": "string",
"description": "",
"example": "/crew/0"
}
}
},
"AppointmentCrewResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"appointment",
"crew"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"appointment": {
"type": "string",
"description": "",
"example": "/appointments/0"
},
"crew": {
"type": "string",
"description": "",
"example": "/crew/0"
}
}
},
"AppointmentRequest": {
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"name": {
"type": "string",
"description": ""
},
"start": {
"type": "string",
"description": "",
"format": "date-time"
},
"end": {
"type": "string",
"description": "",
"format": "date-time"
},
"color": {
"type": "string",
"description": ""
},
"location": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"is_public": {
"type": "boolean",
"description": ""
},
"is_plannable": {
"type": "boolean",
"description": "If yes, employees can be scheduled during this appointment."
}
}
},
"AppointmentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"start",
"end",
"color",
"location",
"remark",
"is_public",
"is_plannable",
"recurrence_interval_unit",
"recurrence_enddate",
"recurrence_interval",
"recurrence_group",
"recurrence_weekdays",
"synchronization_id",
"synchronisation_uri"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"start": {
"type": "string",
"description": "",
"format": "date-time"
},
"end": {
"type": "string",
"description": "",
"format": "date-time"
},
"color": {
"type": "string",
"description": ""
},
"location": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"is_public": {
"type": "boolean",
"description": ""
},
"is_plannable": {
"type": "boolean",
"description": "If yes, employees can be scheduled during this appointment."
},
"recurrence_interval_unit": {
"type": "string",
"description": "Period between each recurrence. E.g. every x day/week/month/year.",
"enum": [
"once",
"days",
"weeks",
"months",
"years",
"specific_days"
]
},
"recurrence_enddate": {
"type": [
"string",
"null"
],
"description": "Date the recurrence ends."
},
"recurrence_interval": {
"type": "integer",
"description": "Number of days/weeks/months/years between each recurrence. E.g. every 2 weeks."
},
"recurrence_group": {
"type": "integer",
"description": "Identification which recurrences belong together."
},
"recurrence_weekdays": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD. Use the integers: 0 = Monday, 1 = Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday."
},
"synchronization_id": {
"type": "string",
"description": ""
},
"synchronisation_uri": {
"type": "string",
"description": ""
}
}
},
"ContactPersonRequest": {
"type": "object",
"required": [],
"properties": {
"firstname": {
"type": "string",
"description": ""
},
"middle_name": {
"type": "string",
"description": ""
},
"lastname": {
"type": "string",
"description": ""
},
"function": {
"type": "string",
"description": ""
},
"phone": {
"type": "string",
"description": ""
},
"street": {
"type": "string",
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"postalcode": {
"type": "string",
"description": ""
},
"city": {
"type": "string",
"description": ""
},
"state": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"mobilephone": {
"type": "string",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email"
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ContactPersonResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"contact",
"firstname",
"middle_name",
"lastname",
"function",
"phone",
"street",
"number",
"postalcode",
"city",
"state",
"country",
"mobilephone",
"email",
"tags",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"contact": {
"type": "string",
"description": "",
"example": "/contacts/0"
},
"firstname": {
"type": "string",
"description": ""
},
"middle_name": {
"type": "string",
"description": ""
},
"lastname": {
"type": "string",
"description": ""
},
"function": {
"type": "string",
"description": ""
},
"phone": {
"type": "string",
"description": ""
},
"street": {
"type": "string",
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"postalcode": {
"type": "string",
"description": ""
},
"city": {
"type": "string",
"description": ""
},
"state": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"mobilephone": {
"type": "string",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email"
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ContactRequest": {
"type": "object",
"required": [],
"properties": {
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"type": {
"type": "string",
"description": "",
"enum": [
"private",
"company"
]
},
"ext_name_line": {
"type": "string",
"description": ""
},
"firstname": {
"type": "string",
"description": ""
},
"distance": {
"type": "number",
"description": "Distance from warehouse to visiting address."
},
"travel_time": {
"type": [
"number",
"null"
],
"description": "Travel time (in minutes) from warehouse to visiting address."
},
"surfix": {
"type": "string",
"description": ""
},
"surname": {
"type": "string",
"description": ""
},
"longitude": {
"type": "number",
"description": ""
},
"latitude": {
"type": "number",
"description": ""
},
"code": {
"type": "string",
"description": "Automatically generated if left empty."
},
"accounting_code": {
"type": "string",
"description": "External identifier used for integrations with accounting software."
},
"vendor_accounting_code": {
"type": "string",
"description": "External identifier used for integrations with accounting software."
},
"name": {
"type": "string",
"description": ""
},
"gender": {
"type": "string",
"description": ""
},
"mailing_city": {
"type": "string",
"description": ""
},
"mailing_street": {
"type": "string",
"description": ""
},
"mailing_number": {
"type": "string",
"description": ""
},
"mailing_unit_number": {
"type": "string",
"description": ""
},
"mailing_district": {
"type": "string",
"description": ""
},
"mailing_extra_address_line": {
"type": "string",
"description": ""
},
"mailing_postalcode": {
"type": "string",
"description": ""
},
"mailing_state": {
"type": "string",
"description": ""
},
"mailing_country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"visit_city": {
"type": "string",
"description": ""
},
"visit_street": {
"type": "string",
"description": ""
},
"visit_number": {
"type": "string",
"description": ""
},
"visit_unit_number": {
"type": "string",
"description": ""
},
"visit_district": {
"type": "string",
"description": ""
},
"visit_extra_address_line": {
"type": "string",
"description": ""
},
"visit_postalcode": {
"type": "string",
"description": ""
},
"visit_state": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"invoice_city": {
"type": "string",
"description": ""
},
"invoice_street": {
"type": "string",
"description": ""
},
"invoice_number": {
"type": "string",
"description": ""
},
"invoice_unit_number": {
"type": "string",
"description": ""
},
"invoice_district": {
"type": "string",
"description": ""
},
"invoice_extra_address_line": {
"type": "string",
"description": ""
},
"invoice_postalcode": {
"type": "string",
"description": ""
},
"invoice_state": {
"type": "string",
"description": ""
},
"invoice_country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"phone_1": {
"type": "string",
"description": ""
},
"phone_2": {
"type": "string",
"description": ""
},
"email_1": {
"type": "string",
"description": "",
"format": "email"
},
"email_2": {
"type": "string",
"description": "",
"format": "email"
},
"website": {
"type": "string",
"description": ""
},
"VAT_code": {
"type": "string",
"description": ""
},
"fiscal_code": {
"type": "string",
"description": "This number is used in file exports of invoices."
},
"commerce_code": {
"type": "string",
"description": ""
},
"purchase_number": {
"type": "string",
"description": ""
},
"bic": {
"type": "string",
"description": ""
},
"bank_account": {
"type": "string",
"description": ""
},
"default_person": {
"type": [
"string",
"null"
],
"description": "This contact person is automatically selected if you choose this contact in a project or subrental.",
"example": "/contactpersons/0"
},
"admin_contactperson": {
"type": [
"string",
"null"
],
"description": "This contact person is automatically selected when creating invoices.",
"example": "/contactpersons/0"
},
"discount_crew": {
"type": "number",
"description": "Discount applied to the 'crew' category upon selecting this contact as a client in a project."
},
"discount_transport": {
"type": "number",
"description": "Discount applied to the 'transport' category upon selecting this contact as a client in a project."
},
"discount_rental": {
"type": "number",
"description": "Discount applied to the 'rental' category upon selecting this contact as a client in a project."
},
"discount_sale": {
"type": "number",
"description": "Discount applied to the 'sales' category upon selecting this contact as a client in a project."
},
"discount_total": {
"type": "number",
"description": "Discount applied to the total (sub)project upon selecting this contact as a client in a project."
},
"projectnote": {
"type": "string",
"description": "This remark is automatically added to projects upon selecting this contact as client or location."
},
"projectnote_title": {
"type": "string",
"description": "This remark is automatically added to projects upon selecting this contact as client or location."
},
"contact_warning": {
"type": "string",
"description": "This warning is shown when this contact is selected as a client in a project."
},
"discount_subrent": {
"type": "number",
"description": "Discount applied to rental equipment upon selecting this contact as a supplier in a subrental."
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ContactResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"folder",
"type",
"ext_name_line",
"firstname",
"distance",
"travel_time",
"surfix",
"surname",
"longitude",
"latitude",
"code",
"accounting_code",
"vendor_accounting_code",
"name",
"gender",
"mailing_city",
"mailing_street",
"mailing_number",
"mailing_unit_number",
"mailing_district",
"mailing_extra_address_line",
"mailing_postalcode",
"mailing_state",
"mailing_country",
"visit_city",
"visit_street",
"visit_number",
"visit_unit_number",
"visit_district",
"visit_extra_address_line",
"visit_postalcode",
"visit_state",
"country",
"invoice_city",
"invoice_street",
"invoice_number",
"invoice_unit_number",
"invoice_district",
"invoice_extra_address_line",
"invoice_postalcode",
"invoice_state",
"invoice_country",
"phone_1",
"phone_2",
"email_1",
"email_2",
"website",
"VAT_code",
"fiscal_code",
"commerce_code",
"purchase_number",
"bic",
"bank_account",
"default_person",
"admin_contactperson",
"discount_crew",
"discount_transport",
"discount_rental",
"discount_sale",
"discount_total",
"projectnote",
"projectnote_title",
"contact_warning",
"discount_subrent",
"image",
"tags",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"type": {
"type": "string",
"description": "",
"enum": [
"private",
"company"
]
},
"ext_name_line": {
"type": "string",
"description": ""
},
"firstname": {
"type": "string",
"description": ""
},
"distance": {
"type": "number",
"description": "Distance from warehouse to visiting address."
},
"travel_time": {
"type": [
"number",
"null"
],
"description": "Travel time (in minutes) from warehouse to visiting address."
},
"surfix": {
"type": "string",
"description": ""
},
"surname": {
"type": "string",
"description": ""
},
"longitude": {
"type": "number",
"description": ""
},
"latitude": {
"type": "number",
"description": ""
},
"code": {
"type": "string",
"description": "Automatically generated if left empty."
},
"accounting_code": {
"type": "string",
"description": "External identifier used for integrations with accounting software."
},
"vendor_accounting_code": {
"type": "string",
"description": "External identifier used for integrations with accounting software."
},
"name": {
"type": "string",
"description": ""
},
"gender": {
"type": "string",
"description": ""
},
"mailing_city": {
"type": "string",
"description": ""
},
"mailing_street": {
"type": "string",
"description": ""
},
"mailing_number": {
"type": "string",
"description": ""
},
"mailing_unit_number": {
"type": "string",
"description": ""
},
"mailing_district": {
"type": "string",
"description": ""
},
"mailing_extra_address_line": {
"type": "string",
"description": ""
},
"mailing_postalcode": {
"type": "string",
"description": ""
},
"mailing_state": {
"type": "string",
"description": ""
},
"mailing_country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"visit_city": {
"type": "string",
"description": ""
},
"visit_street": {
"type": "string",
"description": ""
},
"visit_number": {
"type": "string",
"description": ""
},
"visit_unit_number": {
"type": "string",
"description": ""
},
"visit_district": {
"type": "string",
"description": ""
},
"visit_extra_address_line": {
"type": "string",
"description": ""
},
"visit_postalcode": {
"type": "string",
"description": ""
},
"visit_state": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"invoice_city": {
"type": "string",
"description": ""
},
"invoice_street": {
"type": "string",
"description": ""
},
"invoice_number": {
"type": "string",
"description": ""
},
"invoice_unit_number": {
"type": "string",
"description": ""
},
"invoice_district": {
"type": "string",
"description": ""
},
"invoice_extra_address_line": {
"type": "string",
"description": ""
},
"invoice_postalcode": {
"type": "string",
"description": ""
},
"invoice_state": {
"type": "string",
"description": ""
},
"invoice_country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"phone_1": {
"type": "string",
"description": ""
},
"phone_2": {
"type": "string",
"description": ""
},
"email_1": {
"type": "string",
"description": "",
"format": "email"
},
"email_2": {
"type": "string",
"description": "",
"format": "email"
},
"website": {
"type": "string",
"description": ""
},
"VAT_code": {
"type": "string",
"description": ""
},
"fiscal_code": {
"type": "string",
"description": "This number is used in file exports of invoices."
},
"commerce_code": {
"type": "string",
"description": ""
},
"purchase_number": {
"type": "string",
"description": ""
},
"bic": {
"type": "string",
"description": ""
},
"bank_account": {
"type": "string",
"description": ""
},
"default_person": {
"type": [
"string",
"null"
],
"description": "This contact person is automatically selected if you choose this contact in a project or subrental.",
"example": "/contactpersons/0"
},
"admin_contactperson": {
"type": [
"string",
"null"
],
"description": "This contact person is automatically selected when creating invoices.",
"example": "/contactpersons/0"
},
"discount_crew": {
"type": "number",
"description": "Discount applied to the 'crew' category upon selecting this contact as a client in a project."
},
"discount_transport": {
"type": "number",
"description": "Discount applied to the 'transport' category upon selecting this contact as a client in a project."
},
"discount_rental": {
"type": "number",
"description": "Discount applied to the 'rental' category upon selecting this contact as a client in a project."
},
"discount_sale": {
"type": "number",
"description": "Discount applied to the 'sales' category upon selecting this contact as a client in a project."
},
"discount_total": {
"type": "number",
"description": "Discount applied to the total (sub)project upon selecting this contact as a client in a project."
},
"projectnote": {
"type": "string",
"description": "This remark is automatically added to projects upon selecting this contact as client or location."
},
"projectnote_title": {
"type": "string",
"description": "This remark is automatically added to projects upon selecting this contact as client or location."
},
"contact_warning": {
"type": "string",
"description": "This warning is shown when this contact is selected as a client in a project."
},
"discount_subrent": {
"type": "number",
"description": "Discount applied to rental equipment upon selecting this contact as a supplier in a subrental."
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ContractRequest": {
"type": "object",
"required": [],
"properties": {
"number": {
"type": "string",
"description": ""
},
"customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"date": {
"type": [
"string",
"null"
],
"description": ""
},
"expiration_date": {
"type": [
"string",
"null"
],
"description": "The date on which this quotation expires."
},
"version": {
"type": "integer",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"show_tax": {
"type": "boolean",
"description": ""
},
"filename": {
"type": "string",
"description": ""
}
}
},
"ContractResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"number",
"customer",
"contact",
"date",
"expiration_date",
"version",
"subject",
"show_tax",
"project",
"filename",
"project_total_price",
"project_total_price_cancelled",
"project_rental_price",
"project_sale_price",
"project_crew_price",
"project_transport_price",
"project_other_price",
"project_insurance_price",
"project_services_price",
"price",
"price_invat",
"vat_amount"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"number": {
"type": "string",
"description": ""
},
"customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"date": {
"type": [
"string",
"null"
],
"description": ""
},
"expiration_date": {
"type": [
"string",
"null"
],
"description": "The date on which this quotation expires."
},
"version": {
"type": "integer",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"show_tax": {
"type": "boolean",
"description": ""
},
"project": {
"type": "string",
"description": "",
"example": "/projects/0"
},
"filename": {
"type": "string",
"description": ""
},
"project_total_price": {
"type": "number",
"description": "GENERATED FIELD. Total of not-canceled subprojects. Not visible in collection responses unless explicitly requested."
},
"project_total_price_cancelled": {
"type": "number",
"description": "GENERATED FIELD. Total cancelled projects. Not visible in collection responses unless explicitly requested."
},
"project_rental_price": {
"type": "number",
"description": "GENERATED FIELD. Total price rental equipment. Not visible in collection responses unless explicitly requested."
},
"project_sale_price": {
"type": "number",
"description": "GENERATED FIELD. Total price sales equipment. Not visible in collection responses unless explicitly requested."
},
"project_crew_price": {
"type": "number",
"description": "GENERATED FIELD. Total price crew. Not visible in collection responses unless explicitly requested."
},
"project_transport_price": {
"type": "number",
"description": "GENERATED FIELD. Total price transport. Not visible in collection responses unless explicitly requested."
},
"project_other_price": {
"type": "number",
"description": "GENERATED FIELD. Total price other costs. Not visible in collection responses unless explicitly requested."
},
"project_insurance_price": {
"type": "number",
"description": "GENERATED FIELD. Total price insurance. Not visible in collection responses unless explicitly requested."
},
"project_services_price": {
"type": "number",
"description": "GENERATED FIELD. Total price services. Not visible in collection responses unless explicitly requested."
},
"price": {
"type": "number",
"description": "GENERATED FIELD."
},
"price_invat": {
"type": "number",
"description": "GENERATED FIELD."
},
"vat_amount": {
"type": "number",
"description": "GENERATED FIELD."
}
}
},
"ProjectCostRequest": {
"type": "object",
"required": [
"subproject"
],
"properties": {
"name": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"quantity": {
"type": "integer",
"description": ""
},
"discount": {
"type": "number",
"description": ""
},
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"is_template": {
"type": "boolean",
"description": ""
},
"taxclass": {
"type": [
"string",
"null"
],
"description": "This class, in combination with the chosen VAT scheme at project level, determines the final VAT rate.",
"example": "/taxclasses/0"
},
"ledger": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"ledger_debit": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"sale_price": {
"type": "number",
"description": ""
},
"purchase_price": {
"type": "number",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectCostResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"remark",
"project",
"quantity",
"discount",
"order",
"subproject",
"is_template",
"taxclass",
"ledger",
"ledger_debit",
"sale_price",
"purchase_price",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"project": {
"type": "string",
"description": "",
"example": "/projects/0"
},
"quantity": {
"type": "integer",
"description": ""
},
"discount": {
"type": "number",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"is_template": {
"type": "boolean",
"description": ""
},
"taxclass": {
"type": [
"string",
"null"
],
"description": "This class, in combination with the chosen VAT scheme at project level, determines the final VAT rate.",
"example": "/taxclasses/0"
},
"ledger": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"ledger_debit": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"sale_price": {
"type": "number",
"description": ""
},
"purchase_price": {
"type": "number",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"CrewRequest": {
"type": "object",
"required": [],
"properties": {
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"street": {
"type": "string",
"description": ""
},
"housenumber": {
"type": "string",
"description": ""
},
"unit_number": {
"type": "string",
"description": ""
},
"district": {
"type": "string",
"description": ""
},
"city": {
"type": "string",
"description": ""
},
"postal_code": {
"type": "string",
"description": ""
},
"addressline2": {
"type": "string",
"description": ""
},
"extraaddressline": {
"type": "string",
"description": ""
},
"state": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"birthdate": {
"type": [
"string",
"null"
],
"description": ""
},
"passport_number": {
"type": "string",
"description": ""
},
"emergency_contact": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"driving_license": {
"type": "string",
"description": ""
},
"contract": {
"type": "string",
"description": ""
},
"bank": {
"type": "string",
"description": ""
},
"contract_date": {
"type": [
"string",
"null"
],
"description": ""
},
"company_name": {
"type": "string",
"description": ""
},
"vat_code": {
"type": "string",
"description": ""
},
"coc_code": {
"type": "string",
"description": ""
},
"firstname": {
"type": "string",
"description": ""
},
"middle_name": {
"type": "string",
"description": ""
},
"lastname": {
"type": "string",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email"
},
"phone": {
"type": "string",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"avatar": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"vt_fullname": {
"type": "string",
"description": ""
},
"default_warehouse": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"external_reference": {
"type": "string",
"description": "Can be used for the employee ID from your accounting software."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"CrewResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"folder",
"street",
"housenumber",
"unit_number",
"district",
"city",
"postal_code",
"addressline2",
"extraaddressline",
"state",
"country",
"birthdate",
"passport_number",
"emergency_contact",
"remark",
"driving_license",
"contract",
"bank",
"contract_date",
"company_name",
"vat_code",
"coc_code",
"firstname",
"middle_name",
"lastname",
"email",
"phone",
"active",
"avatar",
"vt_fullname",
"default_warehouse",
"external_reference",
"tags",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"street": {
"type": "string",
"description": ""
},
"housenumber": {
"type": "string",
"description": ""
},
"unit_number": {
"type": "string",
"description": ""
},
"district": {
"type": "string",
"description": ""
},
"city": {
"type": "string",
"description": ""
},
"postal_code": {
"type": "string",
"description": ""
},
"addressline2": {
"type": "string",
"description": ""
},
"extraaddressline": {
"type": "string",
"description": ""
},
"state": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"birthdate": {
"type": [
"string",
"null"
],
"description": ""
},
"passport_number": {
"type": "string",
"description": ""
},
"emergency_contact": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"driving_license": {
"type": "string",
"description": ""
},
"contract": {
"type": "string",
"description": ""
},
"bank": {
"type": "string",
"description": ""
},
"contract_date": {
"type": [
"string",
"null"
],
"description": ""
},
"company_name": {
"type": "string",
"description": ""
},
"vat_code": {
"type": "string",
"description": ""
},
"coc_code": {
"type": "string",
"description": ""
},
"firstname": {
"type": "string",
"description": ""
},
"middle_name": {
"type": "string",
"description": ""
},
"lastname": {
"type": "string",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email"
},
"phone": {
"type": "string",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"avatar": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"vt_fullname": {
"type": "string",
"description": ""
},
"default_warehouse": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"external_reference": {
"type": "string",
"description": "Can be used for the employee ID from your accounting software."
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"CrewAvailabilityRequest": {
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"last_updater": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"last_updated": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"start": {
"type": "string",
"description": "",
"format": "date-time"
},
"end": {
"type": "string",
"description": "",
"format": "date-time"
},
"status": {
"type": "string",
"description": "\n`B` - This value is returned when the crew availability status is available \n`N` - This value is returned when the crew availability status is unavailable \n`O` - This value is returned when the crew availability status is unknown .",
"enum": [
"B",
"N",
"O"
]
},
"remark": {
"type": "string",
"description": ""
},
"recurrence_interval_unit": {
"type": "string",
"description": "",
"enum": [
"once",
"days",
"weeks",
"months",
"years",
"specific_days"
]
},
"recurrence_enddate": {
"type": [
"string",
"null"
],
"description": ""
},
"recurrence_interval": {
"type": "integer",
"description": "interval in how many days/weeks/months/years the availability should reoccur."
},
"recurrent_group": {
"type": "integer",
"description": ""
},
"recurrence_weekdays": {
"type": "string",
"description": "GENERATED FIELD. Use the integers: 0 = Monday, 1 = Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday. E.g.: for a recurrence on Monday and Wednesday, use [0, 2]."
}
}
},
"CrewAvailabilityResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"last_updater",
"last_updated",
"start",
"end",
"crewmember",
"status",
"remark",
"recurrence_interval_unit",
"recurrence_enddate",
"recurrence_interval",
"recurrent_group",
"recurrence_weekdays"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"last_updater": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"last_updated": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"start": {
"type": "string",
"description": "",
"format": "date-time"
},
"end": {
"type": "string",
"description": "",
"format": "date-time"
},
"crewmember": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"status": {
"type": "string",
"description": "\n`B` - This value is returned when the crew availability status is available \n`N` - This value is returned when the crew availability status is unavailable \n`O` - This value is returned when the crew availability status is unknown .",
"enum": [
"B",
"N",
"O"
]
},
"remark": {
"type": "string",
"description": ""
},
"recurrence_interval_unit": {
"type": "string",
"description": "",
"enum": [
"once",
"days",
"weeks",
"months",
"years",
"specific_days"
]
},
"recurrence_enddate": {
"type": [
"string",
"null"
],
"description": ""
},
"recurrence_interval": {
"type": "integer",
"description": "interval in how many days/weeks/months/years the availability should reoccur."
},
"recurrent_group": {
"type": "integer",
"description": ""
},
"recurrence_weekdays": {
"type": "string",
"description": "GENERATED FIELD. Use the integers: 0 = Monday, 1 = Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday. E.g.: for a recurrence on Monday and Wednesday, use [0, 2]."
}
}
},
"CrewRatesRequest": {
"type": "object",
"required": [],
"properties": {
"naam": {
"type": "string",
"description": ""
},
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
}
}
},
"CrewRatesResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"naam",
"cost_rate",
"medewerker"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"naam": {
"type": "string",
"description": ""
},
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
},
"medewerker": {
"type": "string",
"description": "",
"example": "/crew/0"
}
}
},
"EquipmentRequest": {
"type": "object",
"required": [],
"properties": {
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"code": {
"type": "string",
"description": ""
},
"factor_group": {
"type": [
"string",
"null"
],
"description": "",
"example": "/factorgroups/0"
},
"name": {
"type": "string",
"description": ""
},
"internal_remark": {
"type": "string",
"description": "Note on packing lists."
},
"external_remark": {
"type": "string",
"description": "Note on financial documents."
},
"unit": {
"type": "string",
"description": ""
},
"in_shop": {
"type": "boolean",
"description": ""
},
"surface_article": {
"type": "boolean",
"description": "Item with price calculation per square meter (width x height). Dimensions can be entered for each project."
},
"shop_description_short": {
"type": "string",
"description": ""
},
"shop_description_long": {
"type": "string",
"description": ""
},
"shop_seo_title": {
"type": "string",
"description": ""
},
"shop_seo_keyword": {
"type": "string",
"description": ""
},
"shop_seo_description": {
"type": "string",
"description": ""
},
"shop_featured": {
"type": "boolean",
"description": ""
},
"price": {
"type": "number",
"description": ""
},
"subrental_costs": {
"type": "number",
"description": ""
},
"critical_stock_level": {
"type": "integer",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"set",
"case",
"item"
]
},
"rental_sales": {
"type": "string",
"description": "",
"enum": [
"Sale",
"Rental"
]
},
"temporary": {
"type": "boolean",
"description": ""
},
"in_planner": {
"type": "boolean",
"description": ""
},
"in_archive": {
"type": "boolean",
"description": ""
},
"stock_management": {
"type": "string",
"description": "",
"enum": [
"Exclude from stock tracking",
"Track stock"
]
},
"taxclass": {
"type": [
"string",
"null"
],
"description": "",
"example": "/taxclasses/0"
},
"list_price": {
"type": "number",
"description": ""
},
"volume": {
"type": "number",
"description": ""
},
"packed_per": {
"type": "integer",
"description": ""
},
"height": {
"type": "number",
"description": ""
},
"width": {
"type": "number",
"description": ""
},
"length": {
"type": "number",
"description": ""
},
"weight": {
"type": "number",
"description": ""
},
"empty_weight": {
"type": "number",
"description": ""
},
"power": {
"type": "number",
"description": ""
},
"current": {
"type": "number",
"description": ""
},
"country_of_origin": {
"type": "string",
"description": "The country where the equipment was manufactured. This is used for e.g. carnet exports.",
"enum": [
"oo",
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"ledger": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"ledger_debit": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"defaultgroup": {
"type": "string",
"description": "Enter an equipment group to automatically place the item in when planning."
},
"is_combination": {
"type": "boolean",
"description": ""
},
"is_physical": {
"type": "string",
"description": "",
"enum": [
"Virtual package",
"Physical equipment"
]
},
"can_edit_content_during_planning": {
"type": "boolean",
"description": "If 'No' is selected, equipment cannot be added to or removed from this combination. Also, quantities of the content cannot be adjusted."
},
"strict_container_content": {
"type": "string",
"description": "Determine whether the combination can contain actual content that is not part of the default content.",
"enum": [
"Unrestricted",
"Strict"
]
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"EquipmentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"folder",
"code",
"factor_group",
"name",
"internal_remark",
"external_remark",
"unit",
"in_shop",
"surface_article",
"shop_description_short",
"shop_description_long",
"shop_seo_title",
"shop_seo_keyword",
"shop_seo_description",
"shop_featured",
"price",
"subrental_costs",
"critical_stock_level",
"type",
"rental_sales",
"temporary",
"in_planner",
"in_archive",
"stock_management",
"taxclass",
"list_price",
"volume",
"packed_per",
"height",
"width",
"length",
"weight",
"empty_weight",
"power",
"current",
"country_of_origin",
"image",
"ledger",
"ledger_debit",
"defaultgroup",
"is_combination",
"is_physical",
"can_edit_content_during_planning",
"strict_container_content",
"qrcodes",
"qrcodes_of_serial_numbers",
"tags",
"current_quantity_excl_cases",
"current_quantity",
"quantity_in_cases",
"location_in_warehouse",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"code": {
"type": "string",
"description": ""
},
"factor_group": {
"type": [
"string",
"null"
],
"description": "",
"example": "/factorgroups/0"
},
"name": {
"type": "string",
"description": ""
},
"internal_remark": {
"type": "string",
"description": "Note on packing lists."
},
"external_remark": {
"type": "string",
"description": "Note on financial documents."
},
"unit": {
"type": "string",
"description": ""
},
"in_shop": {
"type": "boolean",
"description": ""
},
"surface_article": {
"type": "boolean",
"description": "Item with price calculation per square meter (width x height). Dimensions can be entered for each project."
},
"shop_description_short": {
"type": "string",
"description": ""
},
"shop_description_long": {
"type": "string",
"description": ""
},
"shop_seo_title": {
"type": "string",
"description": ""
},
"shop_seo_keyword": {
"type": "string",
"description": ""
},
"shop_seo_description": {
"type": "string",
"description": ""
},
"shop_featured": {
"type": "boolean",
"description": ""
},
"price": {
"type": "number",
"description": ""
},
"subrental_costs": {
"type": "number",
"description": ""
},
"critical_stock_level": {
"type": "integer",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"set",
"case",
"item"
]
},
"rental_sales": {
"type": "string",
"description": "",
"enum": [
"Sale",
"Rental"
]
},
"temporary": {
"type": "boolean",
"description": ""
},
"in_planner": {
"type": "boolean",
"description": ""
},
"in_archive": {
"type": "boolean",
"description": ""
},
"stock_management": {
"type": "string",
"description": "",
"enum": [
"Exclude from stock tracking",
"Track stock"
]
},
"taxclass": {
"type": [
"string",
"null"
],
"description": "",
"example": "/taxclasses/0"
},
"list_price": {
"type": "number",
"description": ""
},
"volume": {
"type": "number",
"description": ""
},
"packed_per": {
"type": "integer",
"description": ""
},
"height": {
"type": "number",
"description": ""
},
"width": {
"type": "number",
"description": ""
},
"length": {
"type": "number",
"description": ""
},
"weight": {
"type": "number",
"description": ""
},
"empty_weight": {
"type": "number",
"description": ""
},
"power": {
"type": "number",
"description": ""
},
"current": {
"type": "number",
"description": ""
},
"country_of_origin": {
"type": "string",
"description": "The country where the equipment was manufactured. This is used for e.g. carnet exports.",
"enum": [
"oo",
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"ledger": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"ledger_debit": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"defaultgroup": {
"type": "string",
"description": "Enter an equipment group to automatically place the item in when planning."
},
"is_combination": {
"type": "boolean",
"description": ""
},
"is_physical": {
"type": "string",
"description": "",
"enum": [
"Virtual package",
"Physical equipment"
]
},
"can_edit_content_during_planning": {
"type": "boolean",
"description": "If 'No' is selected, equipment cannot be added to or removed from this combination. Also, quantities of the content cannot be adjusted."
},
"strict_container_content": {
"type": "string",
"description": "Determine whether the combination can contain actual content that is not part of the default content.",
"enum": [
"Unrestricted",
"Strict"
]
},
"qrcodes": {
"type": "string",
"description": "GENERATED FIELD."
},
"qrcodes_of_serial_numbers": {
"type": "string",
"description": "GENERATED FIELD."
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"current_quantity_excl_cases": {
"type": "integer",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"current_quantity": {
"type": "integer",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"quantity_in_cases": {
"type": "integer",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"location_in_warehouse": {
"type": "string",
"description": "GENERATED FIELD."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"EquipmentAssignedSerialsRequest": {
"type": "object",
"required": [
"serialnumber"
],
"properties": {
"serialnumber": {
"type": "string",
"description": "",
"example": "/serialnumbers/0"
}
}
},
"EquipmentAssignedSerialsResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"combination",
"serialnumber"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"combination": {
"type": "string",
"description": "",
"example": "/serialnumbers/0"
},
"serialnumber": {
"type": "string",
"description": "",
"example": "/serialnumbers/0"
}
}
},
"EquipmentSetContentRequest": {
"type": "object",
"required": [
"equipment"
],
"properties": {
"quantity": {
"type": "string",
"description": "Quantity in this combination."
},
"order": {
"type": "string",
"description": ""
},
"equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"is_fixed": {
"type": "string",
"description": "Permanently reduce the stock by the amount from this combination.",
"enum": [
"Available outside this combination",
"Reserved from stock"
]
},
"is_physically_connected": {
"type": "string",
"description": "When emptying combinations in the warehouse, this equipment remains inside the combination. Manual removal from the combination in the actual content tab of the combination remains possible at all times.",
"enum": [
"Will be removed when emptying combinations",
"Will remain in the combination when emptying combinations"
]
}
}
},
"EquipmentSetContentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"quantity",
"parent_equipment",
"order",
"equipment",
"is_fixed",
"is_physically_connected"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"quantity": {
"type": "string",
"description": "Quantity in this combination."
},
"parent_equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"order": {
"type": "string",
"description": ""
},
"equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"is_fixed": {
"type": "string",
"description": "Permanently reduce the stock by the amount from this combination.",
"enum": [
"Available outside this combination",
"Reserved from stock"
]
},
"is_physically_connected": {
"type": "string",
"description": "When emptying combinations in the warehouse, this equipment remains inside the combination. Manual removal from the combination in the actual content tab of the combination remains possible at all times.",
"enum": [
"Will be removed when emptying combinations",
"Will remain in the combination when emptying combinations"
]
}
}
},
"ExtraInputFieldRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"itemtype": {
"type": "string",
"description": "",
"enum": [
"Contact",
"Subproject",
"Project",
"Materiaal",
"Person",
"Exemplaar",
"Medewerker",
"Voertuig",
"Functie",
"Planningmateriaal",
"Planningpersoneel",
"Planningtransport",
"Standaardfunctie",
"Dienst",
"Standaarddienst",
"Uren",
"Reparatie",
"Inhuur",
"Cost",
"Service",
"DefaultCost",
"DefaultService",
"Keuringreport",
"PurchaseOrder",
"Taak"
]
},
"linkedItemType": {
"type": "string",
"description": "",
"enum": [
"Contact",
"Medewerker"
]
},
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/extrainputfields/0"
},
"type": {
"type": "string",
"description": "",
"enum": [
"bool",
"color",
"date",
"datetime",
"double",
"enum",
"int",
"longtext",
"price",
"text",
"html",
"item",
"url",
"phone"
]
},
"order": {
"type": "string",
"description": ""
},
"hidden": {
"type": "boolean",
"description": "Hides the field anywhere in the system."
},
"classified": {
"type": "boolean",
"description": "Confidential fields are only visible to people with permission to see confidential fields."
},
"search_include": {
"type": "boolean",
"description": "Enable this option to make this field for searchable in the overviews."
},
"search_minlength": {
"type": "integer",
"description": "The minimum length that a search term must have before this field is searchable."
},
"is_customfield_mandatory": {
"type": "boolean",
"description": "Required input fields must be filled in."
}
}
},
"ExtraInputFieldResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"itemtype",
"linkedItemType",
"parent",
"type",
"order",
"hidden",
"classified",
"search_include",
"search_minlength",
"is_customfield_mandatory"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"itemtype": {
"type": "string",
"description": "",
"enum": [
"Contact",
"Subproject",
"Project",
"Materiaal",
"Person",
"Exemplaar",
"Medewerker",
"Voertuig",
"Functie",
"Planningmateriaal",
"Planningpersoneel",
"Planningtransport",
"Standaardfunctie",
"Dienst",
"Standaarddienst",
"Uren",
"Reparatie",
"Inhuur",
"Cost",
"Service",
"DefaultCost",
"DefaultService",
"Keuringreport",
"PurchaseOrder",
"Taak"
]
},
"linkedItemType": {
"type": "string",
"description": "",
"enum": [
"Contact",
"Medewerker"
]
},
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/extrainputfields/0"
},
"type": {
"type": "string",
"description": "",
"enum": [
"bool",
"color",
"date",
"datetime",
"double",
"enum",
"int",
"longtext",
"price",
"text",
"html",
"item",
"url",
"phone"
]
},
"order": {
"type": "string",
"description": ""
},
"hidden": {
"type": "boolean",
"description": "Hides the field anywhere in the system."
},
"classified": {
"type": "boolean",
"description": "Confidential fields are only visible to people with permission to see confidential fields."
},
"search_include": {
"type": "boolean",
"description": "Enable this option to make this field for searchable in the overviews."
},
"search_minlength": {
"type": "integer",
"description": "The minimum length that a search term must have before this field is searchable."
},
"is_customfield_mandatory": {
"type": "boolean",
"description": "Required input fields must be filled in."
}
}
},
"FactorGroupsRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
}
}
},
"FactorGroupsResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
}
}
},
"FactorsRequest": {
"type": "object",
"required": [],
"properties": {
"from_days": {
"type": "integer",
"description": ""
},
"to_days": {
"type": "integer",
"description": ""
},
"factor": {
"type": "string",
"description": ""
}
}
},
"FactorsResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"from_days",
"to_days",
"factor",
"factor_group"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"from_days": {
"type": "integer",
"description": ""
},
"to_days": {
"type": "integer",
"description": ""
},
"factor": {
"type": "string",
"description": ""
},
"factor_group": {
"type": "string",
"description": "",
"example": "/factorgroups/0"
}
}
},
"FileFolderRequest": {
"type": "object",
"required": [],
"properties": {
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/file_folders/0"
},
"name": {
"type": "string",
"description": ""
},
"classified": {
"type": "boolean",
"description": "Confidential folders are only visible with the user right to download all files."
},
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"itemtype": {
"type": [
"string",
"null"
],
"description": "",
"enum": [
"Contact",
"Container",
"SerialNumber",
"Subrental",
"InspectionReportSerialNumber",
"Supplier",
"Equipment",
"LostEquipment",
"Crew",
"ContactPerson",
"Project",
"PurchaseOrder",
"Repair",
"Subproject",
"Task",
"Vehicle"
]
}
}
},
"FileFolderResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"parent",
"name",
"classified",
"item",
"itemtype",
"is_template",
"parent_api_path"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/file_folders/0"
},
"name": {
"type": "string",
"description": ""
},
"classified": {
"type": "boolean",
"description": "Confidential folders are only visible with the user right to download all files."
},
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"itemtype": {
"type": [
"string",
"null"
],
"description": "",
"enum": [
"Contact",
"Container",
"SerialNumber",
"Subrental",
"InspectionReportSerialNumber",
"Supplier",
"Equipment",
"LostEquipment",
"Crew",
"ContactPerson",
"Project",
"PurchaseOrder",
"Repair",
"Subproject",
"Task",
"Vehicle"
]
},
"is_template": {
"type": "boolean",
"description": ""
},
"parent_api_path": {
"type": "string",
"description": "GENERATED FIELD. ~~The API path of the parent item. Use this path to fetch the parent item directly from the API.~~."
}
}
},
"FileRequest": {
"type": "object",
"required": [],
"properties": {
"readable_name": {
"type": "string",
"description": ""
},
"expiration": {
"type": [
"string",
"null"
],
"description": ""
},
"size": {
"type": "integer",
"description": ""
},
"image": {
"type": "boolean",
"description": ""
},
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"itemtype": {
"type": [
"string",
"null"
],
"description": "",
"enum": [
"Contact",
"Container",
"Contract",
"CrewDocument",
"EmailNote",
"SerialNumber",
"Factuur",
"ImageLibrary",
"Subrental",
"InventoryCountJob",
"InvitationEmailTemplate",
"InspectionReportSerialNumber",
"Supplier",
"Equipment",
"LostEquipment",
"Crew",
"Quotation",
"ContactPerson",
"Project",
"PurchaseOrder",
"PublishedQuote",
"Repair",
"State",
"Task",
"TimeRegistration",
"Vehicle"
]
},
"description": {
"type": "string",
"description": ""
},
"in_documents": {
"type": "boolean",
"description": "This setting relates to the block of images in document templates."
},
"in_webshop": {
"type": "boolean",
"description": ""
},
"classified": {
"type": "boolean",
"description": "Confidential files are only visible with the user right to download all files."
},
"public": {
"type": "boolean",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"preview_of": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"previewstatus": {
"type": "string",
"description": "",
"enum": [
"no",
"yes",
"failed"
]
},
"file_item": {
"type": "integer",
"description": ""
},
"file_itemtype": {
"type": "string",
"description": ""
},
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/file_folders/0"
}
}
},
"FileResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"readable_name",
"expiration",
"size",
"image",
"item",
"itemtype",
"description",
"in_documents",
"in_webshop",
"classified",
"public",
"type",
"preview_of",
"previewstatus",
"file_item",
"file_itemtype",
"folder",
"path",
"path_without_file_name",
"path_with_file_folders",
"name_without_extension",
"friendly_name_without_extension",
"extension",
"url",
"proxy_url",
"parent_api_path"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"readable_name": {
"type": "string",
"description": ""
},
"expiration": {
"type": [
"string",
"null"
],
"description": ""
},
"size": {
"type": "integer",
"description": ""
},
"image": {
"type": "boolean",
"description": ""
},
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"itemtype": {
"type": [
"string",
"null"
],
"description": "",
"enum": [
"Contact",
"Container",
"Contract",
"CrewDocument",
"EmailNote",
"SerialNumber",
"Factuur",
"ImageLibrary",
"Subrental",
"InventoryCountJob",
"InvitationEmailTemplate",
"InspectionReportSerialNumber",
"Supplier",
"Equipment",
"LostEquipment",
"Crew",
"Quotation",
"ContactPerson",
"Project",
"PurchaseOrder",
"PublishedQuote",
"Repair",
"State",
"Task",
"TimeRegistration",
"Vehicle"
]
},
"description": {
"type": "string",
"description": ""
},
"in_documents": {
"type": "boolean",
"description": "This setting relates to the block of images in document templates."
},
"in_webshop": {
"type": "boolean",
"description": ""
},
"classified": {
"type": "boolean",
"description": "Confidential files are only visible with the user right to download all files."
},
"public": {
"type": "boolean",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"preview_of": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"previewstatus": {
"type": "string",
"description": "",
"enum": [
"no",
"yes",
"failed"
]
},
"file_item": {
"type": "integer",
"description": ""
},
"file_itemtype": {
"type": "string",
"description": ""
},
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/file_folders/0"
},
"path": {
"type": "string",
"description": "GENERATED FIELD."
},
"path_without_file_name": {
"type": "string",
"description": "GENERATED FIELD."
},
"path_with_file_folders": {
"type": "string",
"description": "GENERATED FIELD."
},
"name_without_extension": {
"type": "string",
"description": "GENERATED FIELD."
},
"friendly_name_without_extension": {
"type": "string",
"description": "GENERATED FIELD."
},
"extension": {
"type": "string",
"description": "GENERATED FIELD."
},
"url": {
"type": "string",
"description": "GENERATED FIELD."
},
"proxy_url": {
"type": "string",
"description": "GENERATED FIELD."
},
"parent_api_path": {
"type": "string",
"description": "GENERATED FIELD. ~~The API path of the parent item. Use this path to fetch the parent item directly from the API.~~."
}
}
},
"FolderRequest": {
"type": "object",
"required": [],
"properties": {
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"name": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"itemtype": {
"type": "string",
"description": "The type of item in this folder.",
"enum": [
"equipment",
"contact",
"vehicle",
"user",
"container",
"project template",
"default function"
]
}
}
},
"FolderResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"parent",
"name",
"order",
"itemtype",
"path"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"name": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"itemtype": {
"type": "string",
"description": "The type of item in this folder.",
"enum": [
"equipment",
"contact",
"vehicle",
"user",
"container",
"project template",
"default function"
]
},
"path": {
"type": "string",
"description": "GENERATED FIELD."
}
}
},
"InvitationsRequest": {
"type": "object",
"required": [],
"properties": {
"type": {
"type": "string",
"description": "\n `availability` - After confirmation, the crew member is marked as available for the specified times. No function or project details are shared. \n `reservation` - After confirmation, the crew member is marked as reserved for the function times or specified times. No function or project details are shared. \n `final_planning` - After confirmation, the crew member is final planned on the function. The details of the function and project are shared. \n `draft_planning` - After confirmation, the crew member is draft planned on the function. The details of the function and project are shared.\n .",
"enum": [
"availability",
"reservation",
"final_planning",
"draft_planning"
]
},
"accepted": {
"type": "boolean",
"description": ""
},
"responded_timestamp": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"expiration_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"function": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectfunctions/0"
},
"projectcrew": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectcrew/0"
},
"remark": {
"type": "string",
"description": ""
},
"emailstatus": {
"type": "string",
"description": "",
"enum": [
"pending",
"new",
"newremind",
"inprogress",
"processed"
]
},
"last_reminder": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"location_details": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD."
},
"auto_reminder_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
}
}
},
"InvitationsResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"type",
"accepted",
"responded_timestamp",
"expiration_date",
"start",
"end",
"function",
"projectcrew",
"crewmember",
"remark",
"emailstatus",
"last_reminder",
"location_details",
"auto_reminder_date",
"auto_reminder_sent"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"type": {
"type": "string",
"description": "\n `availability` - After confirmation, the crew member is marked as available for the specified times. No function or project details are shared. \n `reservation` - After confirmation, the crew member is marked as reserved for the function times or specified times. No function or project details are shared. \n `final_planning` - After confirmation, the crew member is final planned on the function. The details of the function and project are shared. \n `draft_planning` - After confirmation, the crew member is draft planned on the function. The details of the function and project are shared.\n .",
"enum": [
"availability",
"reservation",
"final_planning",
"draft_planning"
]
},
"accepted": {
"type": "boolean",
"description": ""
},
"responded_timestamp": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"expiration_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"function": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectfunctions/0"
},
"projectcrew": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectcrew/0"
},
"crewmember": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"remark": {
"type": "string",
"description": ""
},
"emailstatus": {
"type": "string",
"description": "",
"enum": [
"pending",
"new",
"newremind",
"inprogress",
"processed"
]
},
"last_reminder": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"location_details": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD."
},
"auto_reminder_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"auto_reminder_sent": {
"type": "integer",
"description": ""
}
}
},
"InvoiceLineRequest": {
"type": "object",
"required": [],
"properties": {
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"base": {
"type": "number",
"description": ""
},
"ledger": {
"type": "string",
"description": "",
"example": "/ledgercodes/0"
}
}
},
"InvoiceLineResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"item",
"base",
"ledger",
"vatrate",
"vatamount",
"priceincl",
"ledgercode",
"parent_api_path"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"base": {
"type": "number",
"description": ""
},
"ledger": {
"type": "string",
"description": "",
"example": "/ledgercodes/0"
},
"vatrate": {
"type": "number",
"description": "GENERATED FIELD."
},
"vatamount": {
"type": "number",
"description": "GENERATED FIELD."
},
"priceincl": {
"type": "number",
"description": "GENERATED FIELD."
},
"ledgercode": {
"type": "string",
"description": "GENERATED FIELD."
},
"parent_api_path": {
"type": "string",
"description": "GENERATED FIELD. ~~The API path of the parent item. Use this path to fetch the parent item directly from the API.~~."
}
}
},
"FactuurRequest": {
"type": "object",
"required": [],
"properties": {
"customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"account_manager": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"expiration": {
"type": [
"string",
"null"
],
"description": "The latest payment date for this invoice."
},
"date": {
"type": [
"string",
"null"
],
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"procent": {
"type": "number",
"description": ""
},
"from_project": {
"type": "boolean",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"finalized": {
"type": "boolean",
"description": ""
},
"integration_reference_id": {
"type": "string",
"description": ""
},
"project": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projects/0"
},
"filename": {
"type": "string",
"description": ""
}
}
},
"FactuurResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"customer",
"account_manager",
"contact",
"expiration",
"date",
"number",
"procent",
"from_project",
"subject",
"finalized",
"integration_reference_id",
"project",
"filename",
"project_total_price",
"project_total_price_cancelled",
"project_rental_price",
"project_sale_price",
"project_crew_price",
"project_transport_price",
"project_other_price",
"project_insurance_price",
"project_services_price",
"sum_factuurregels",
"price",
"price_invat",
"vat_amount",
"invoicetype",
"outstanding_balance",
"total_paid",
"is_paid",
"date_sent",
"payment_reminder_sent",
"final_payment_reminder_sent",
"payment_date",
"days_after_expiry",
"tags"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"account_manager": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"expiration": {
"type": [
"string",
"null"
],
"description": "The latest payment date for this invoice."
},
"date": {
"type": [
"string",
"null"
],
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"procent": {
"type": "number",
"description": ""
},
"from_project": {
"type": "boolean",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"finalized": {
"type": "boolean",
"description": ""
},
"integration_reference_id": {
"type": "string",
"description": ""
},
"project": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projects/0"
},
"filename": {
"type": "string",
"description": ""
},
"project_total_price": {
"type": "number",
"description": "GENERATED FIELD. Total of not-canceled subprojects. Not visible in collection responses unless explicitly requested."
},
"project_total_price_cancelled": {
"type": "number",
"description": "GENERATED FIELD. Total cancelled projects. Not visible in collection responses unless explicitly requested."
},
"project_rental_price": {
"type": "number",
"description": "GENERATED FIELD. Total price rental equipment. Not visible in collection responses unless explicitly requested."
},
"project_sale_price": {
"type": "number",
"description": "GENERATED FIELD. Total price sales equipment. Not visible in collection responses unless explicitly requested."
},
"project_crew_price": {
"type": "number",
"description": "GENERATED FIELD. Total price crew. Not visible in collection responses unless explicitly requested."
},
"project_transport_price": {
"type": "number",
"description": "GENERATED FIELD. Total price transport. Not visible in collection responses unless explicitly requested."
},
"project_other_price": {
"type": "number",
"description": "GENERATED FIELD. Total price other costs. Not visible in collection responses unless explicitly requested."
},
"project_insurance_price": {
"type": "number",
"description": "GENERATED FIELD. Total price insurance. Not visible in collection responses unless explicitly requested."
},
"project_services_price": {
"type": "number",
"description": "GENERATED FIELD. Total price services. Not visible in collection responses unless explicitly requested."
},
"sum_factuurregels": {
"type": "number",
"description": "GENERATED FIELD."
},
"price": {
"type": "number",
"description": "GENERATED FIELD."
},
"price_invat": {
"type": "number",
"description": "GENERATED FIELD."
},
"vat_amount": {
"type": "number",
"description": "GENERATED FIELD."
},
"invoicetype": {
"type": "string",
"description": "GENERATED FIELD.",
"enum": [
"C",
"F"
]
},
"outstanding_balance": {
"type": "number",
"description": "GENERATED FIELD."
},
"total_paid": {
"type": "number",
"description": "GENERATED FIELD."
},
"is_paid": {
"type": "boolean",
"description": "GENERATED FIELD."
},
"date_sent": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"payment_reminder_sent": {
"type": "integer",
"description": "GENERATED FIELD."
},
"final_payment_reminder_sent": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"payment_date": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD."
},
"days_after_expiry": {
"type": "integer",
"description": "GENERATED FIELD."
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
}
}
},
"LeaveMutationsRequest": {
"type": "object",
"required": [
"crewmember",
"leavetype"
],
"properties": {
"description": {
"type": "string",
"description": ""
},
"duration": {
"type": "number",
"description": ""
},
"crewmember": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"leavetype": {
"type": "string",
"description": "",
"example": "/leavetypes/0"
},
"mutation_date": {
"type": "string",
"description": ""
}
}
},
"LeaveMutationsResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"description",
"duration",
"crewmember",
"leavetype",
"mutation_date"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"description": {
"type": "string",
"description": ""
},
"duration": {
"type": "number",
"description": ""
},
"crewmember": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"leavetype": {
"type": "string",
"description": "",
"example": "/leavetypes/0"
},
"mutation_date": {
"type": "string",
"description": ""
}
}
},
"LeaveRequestRequest": {
"type": "object",
"required": [
"requested_for"
],
"properties": {
"description": {
"type": "string",
"description": ""
},
"approval_status": {
"type": "string",
"description": "",
"enum": [
"pending",
"approved",
"rejected",
"canceled"
]
},
"requested_for": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"reviewed_on": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"reviewer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
}
}
},
"LeaveRequestResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"description",
"approval_status",
"requested_for",
"reviewed_on",
"reviewer"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"description": {
"type": "string",
"description": ""
},
"approval_status": {
"type": "string",
"description": "",
"enum": [
"pending",
"approved",
"rejected",
"canceled"
]
},
"requested_for": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"reviewed_on": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"reviewer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
}
}
},
"LeaveTypesRequest": {
"type": "object",
"required": [],
"properties": {
"type": {
"type": "string",
"description": "",
"enum": [
"C",
"V",
"Z",
"F",
"G"
]
},
"name": {
"type": "string",
"description": ""
},
"payroll_code": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"requires_approval": {
"type": "boolean",
"description": ""
},
"affects_availability": {
"type": "boolean",
"description": ""
},
"has_balance": {
"type": "boolean",
"description": ""
},
"balance_start_date": {
"type": [
"string",
"null"
],
"description": ""
},
"is_labor": {
"type": "string",
"description": "",
"enum": [
"leave",
"worked"
]
},
"has_calculated_duration": {
"type": "boolean",
"description": ""
},
"can_have_activities": {
"type": "boolean",
"description": ""
}
}
},
"LeaveTypesResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"type",
"name",
"payroll_code",
"color",
"requires_approval",
"affects_availability",
"has_balance",
"balance_start_date",
"is_labor",
"has_calculated_duration",
"can_have_activities",
"counts_in_totals"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"type": {
"type": "string",
"description": "",
"enum": [
"C",
"V",
"Z",
"F",
"G"
]
},
"name": {
"type": "string",
"description": ""
},
"payroll_code": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"requires_approval": {
"type": "boolean",
"description": ""
},
"affects_availability": {
"type": "boolean",
"description": ""
},
"has_balance": {
"type": "boolean",
"description": ""
},
"balance_start_date": {
"type": [
"string",
"null"
],
"description": ""
},
"is_labor": {
"type": "string",
"description": "",
"enum": [
"leave",
"worked"
]
},
"has_calculated_duration": {
"type": "boolean",
"description": ""
},
"can_have_activities": {
"type": "boolean",
"description": ""
},
"counts_in_totals": {
"type": "boolean",
"description": ""
}
}
},
"LedgerRequest": {
"type": "object",
"required": [],
"properties": {
"code": {
"type": "string",
"description": ""
},
"is_credit": {
"type": "boolean",
"description": ""
},
"is_debit": {
"type": "boolean",
"description": ""
}
}
},
"LedgerResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"code",
"is_credit",
"is_debit"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"code": {
"type": "string",
"description": ""
},
"is_credit": {
"type": "boolean",
"description": ""
},
"is_debit": {
"type": "boolean",
"description": ""
}
}
},
"PaymentRequest": {
"type": "object",
"required": [
"moment"
],
"properties": {
"moment": {
"type": "string",
"description": "",
"format": "date-time"
},
"amount": {
"type": "number",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"payment_import_source": {
"type": "string",
"description": "Accounting software this payment was imported from.",
"enum": [
"none",
"exactonline",
"quickbooks",
"xero",
"publicapi"
]
}
}
},
"PaymentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"invoice",
"moment",
"amount",
"description",
"payment_import_source"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"invoice": {
"type": "string",
"description": "",
"example": "/invoices/0"
},
"moment": {
"type": "string",
"description": "",
"format": "date-time"
},
"amount": {
"type": "number",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"payment_import_source": {
"type": "string",
"description": "Accounting software this payment was imported from.",
"enum": [
"none",
"exactonline",
"quickbooks",
"xero",
"publicapi"
]
}
}
},
"ProjectCrewRequest": {
"type": "object",
"required": [
"crewmember"
],
"properties": {
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
},
"cost_accommodation": {
"type": "number",
"description": ""
},
"cost_catering": {
"type": "number",
"description": ""
},
"cost_travel": {
"type": "number",
"description": ""
},
"cost_other": {
"type": "number",
"description": ""
},
"crewmember": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"visible": {
"type": "boolean",
"description": ""
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"transport": {
"type": "string",
"description": "",
"enum": [
"no_transport",
"round_trip",
"only_way_there",
"only_way_back"
]
},
"remark": {
"type": "string",
"description": ""
},
"remark_planner": {
"type": "string",
"description": "Only visible to crew planners."
},
"invoice_reference": {
"type": "string",
"description": ""
},
"project_leader": {
"type": "boolean",
"description": ""
},
"is_visible_on_dashboard": {
"type": "boolean",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectCrewResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"cost_rate",
"cost_accommodation",
"cost_catering",
"cost_travel",
"cost_other",
"function",
"crewmember",
"visible",
"planperiod_start",
"planperiod_end",
"transport",
"remark",
"remark_planner",
"invoice_reference",
"project_leader",
"is_visible_on_dashboard",
"costs",
"cost_actual",
"hours_registered",
"hours_planned",
"cost_planned",
"diff_cost",
"diff_hours",
"activity_status",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
},
"cost_accommodation": {
"type": "number",
"description": ""
},
"cost_catering": {
"type": "number",
"description": ""
},
"cost_travel": {
"type": "number",
"description": ""
},
"cost_other": {
"type": "number",
"description": ""
},
"function": {
"type": "string",
"description": "",
"example": "/projectfunctions/0"
},
"crewmember": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"visible": {
"type": "boolean",
"description": ""
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"transport": {
"type": "string",
"description": "",
"enum": [
"no_transport",
"round_trip",
"only_way_there",
"only_way_back"
]
},
"remark": {
"type": "string",
"description": ""
},
"remark_planner": {
"type": "string",
"description": "Only visible to crew planners."
},
"invoice_reference": {
"type": "string",
"description": ""
},
"project_leader": {
"type": "boolean",
"description": ""
},
"is_visible_on_dashboard": {
"type": "boolean",
"description": ""
},
"costs": {
"type": "number",
"description": "GENERATED FIELD."
},
"cost_actual": {
"type": "number",
"description": "GENERATED FIELD. Costs for this activity based on the chosen rate and the registered hours of the scheduled crew member."
},
"hours_registered": {
"type": [
"number",
"null"
],
"description": "GENERATED FIELD. Sum of the number of registered hours linked to this activity."
},
"hours_planned": {
"type": [
"number",
"null"
],
"description": "GENERATED FIELD. Duration of the activity minus the break defined in the function."
},
"cost_planned": {
"type": "number",
"description": "GENERATED FIELD. Costs for this activity are based on the chosen rate and the duration of the scheduled crew member."
},
"diff_cost": {
"type": "number",
"description": "GENERATED FIELD."
},
"diff_hours": {
"type": [
"number",
"null"
],
"description": "GENERATED FIELD."
},
"activity_status": {
"type": "string",
"description": "GENERATED FIELD.",
"enum": [
"no_registration",
"planned",
"exceeds_time",
"aligned",
"under_time"
]
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectEquipmentRequest": {
"type": "object",
"required": [],
"properties": {
"equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"parent": {
"type": [
"string",
"null"
],
"description": "The combination it is part of.",
"example": "/projectequipment/0"
},
"ledger": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"ledger_debit": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"quantity": {
"type": "string",
"description": ""
},
"quantity_total": {
"type": "integer",
"description": ""
},
"discount": {
"type": "number",
"description": ""
},
"is_option": {
"type": "boolean",
"description": ""
},
"factor": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"unit_price": {
"type": "number",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"external_remark": {
"type": "string",
"description": "Note on financial documents."
},
"internal_remark": {
"type": "string",
"description": "Note on packing lists."
},
"delay_notified": {
"type": "boolean",
"description": ""
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"is_delayed": {
"type": "boolean",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectEquipmentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"equipment",
"parent",
"ledger",
"ledger_debit",
"quantity",
"quantity_total",
"equipment_group",
"discount",
"is_option",
"factor",
"order",
"unit_price",
"name",
"external_remark",
"internal_remark",
"delay_notified",
"duration",
"is_delayed",
"planperiod_start",
"planperiod_end",
"usageperiod_start",
"usageperiod_end",
"has_missings",
"warehouse_reservations",
"subrent_reservations",
"serial_number_ids",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"parent": {
"type": [
"string",
"null"
],
"description": "The combination it is part of.",
"example": "/projectequipment/0"
},
"ledger": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"ledger_debit": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"quantity": {
"type": "string",
"description": ""
},
"quantity_total": {
"type": "integer",
"description": ""
},
"equipment_group": {
"type": "string",
"description": "",
"example": "/projectequipmentgroup/0"
},
"discount": {
"type": "number",
"description": ""
},
"is_option": {
"type": "boolean",
"description": ""
},
"factor": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"unit_price": {
"type": "number",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"external_remark": {
"type": "string",
"description": "Note on financial documents."
},
"internal_remark": {
"type": "string",
"description": "Note on packing lists."
},
"delay_notified": {
"type": "boolean",
"description": ""
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"is_delayed": {
"type": "boolean",
"description": ""
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"has_missings": {
"type": "boolean",
"description": "GENERATED FIELD."
},
"warehouse_reservations": {
"type": "integer",
"description": "GENERATED FIELD."
},
"subrent_reservations": {
"type": "integer",
"description": "GENERATED FIELD."
},
"serial_number_ids": {
"type": "string",
"description": "GENERATED FIELD."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectEquipmentGroupRequest": {
"type": "object",
"required": [
"subproject"
],
"properties": {
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"additional_scanned": {
"type": "boolean",
"description": "This group was additionally scanned from the warehouse."
},
"name": {
"type": "string",
"description": ""
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"is_delayed": {
"type": "boolean",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"in_price_calculation": {
"type": "boolean",
"description": ""
},
"remark": {
"type": "string",
"description": ""
}
}
},
"ProjectEquipmentGroupResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"project",
"subproject",
"additional_scanned",
"name",
"usageperiod_start",
"usageperiod_end",
"duration",
"planperiod_start",
"planperiod_end",
"is_delayed",
"order",
"in_price_calculation",
"remark",
"weight",
"power",
"current",
"volume",
"total_new_price"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"project": {
"type": "string",
"description": "",
"example": "/projects/0"
},
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"additional_scanned": {
"type": "boolean",
"description": "This group was additionally scanned from the warehouse."
},
"name": {
"type": "string",
"description": ""
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"is_delayed": {
"type": "boolean",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"in_price_calculation": {
"type": "boolean",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"weight": {
"type": "number",
"description": "GENERATED FIELD."
},
"power": {
"type": "number",
"description": "GENERATED FIELD."
},
"current": {
"type": "number",
"description": "GENERATED FIELD."
},
"volume": {
"type": "number",
"description": "GENERATED FIELD."
},
"total_new_price": {
"type": "number",
"description": "GENERATED FIELD."
}
}
},
"ProjectFunctionGroupRequest": {
"type": "object",
"required": [
"subproject"
],
"properties": {
"name": {
"type": "string",
"description": ""
},
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"remark": {
"type": "string",
"description": ""
}
}
},
"ProjectFunctionGroupResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"project",
"subproject",
"duration",
"planperiod_start_schedule_is_start",
"usageperiod_start_schedule_is_start",
"planperiod_end_schedule_is_start",
"usageperiod_end_schedule_is_start",
"usageperiod_start",
"usageperiod_end",
"planperiod_start",
"planperiod_end",
"remark"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"project": {
"type": "string",
"description": "",
"example": "/projects/0"
},
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"planperiod_start_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"is_end",
"is_start"
]
},
"usageperiod_start_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"is_end",
"is_start"
]
},
"planperiod_end_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"is_end",
"is_start"
]
},
"usageperiod_end_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"is_end",
"is_start"
]
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"remark": {
"type": "string",
"description": ""
}
}
},
"ProjectFunctionRequest": {
"type": "object",
"required": [
"cost_rate",
"price_rate",
"subproject"
],
"properties": {
"cost_rate": {
"type": "string",
"description": "",
"example": "/rates/0"
},
"cost_accommodation": {
"type": "number",
"description": ""
},
"cost_catering": {
"type": "number",
"description": ""
},
"cost_travel": {
"type": "number",
"description": ""
},
"cost_other": {
"type": "number",
"description": ""
},
"price_rate": {
"type": "string",
"description": "",
"example": "/rates/0"
},
"price_accommodation": {
"type": "number",
"description": ""
},
"price_catering": {
"type": "number",
"description": ""
},
"price_travel": {
"type": "number",
"description": ""
},
"price_other": {
"type": "number",
"description": ""
},
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"group": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectfunctiongroups/0"
},
"name_external": {
"type": "string",
"description": "Name on financial documents."
},
"name": {
"type": "string",
"description": "Name on packing lists."
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"type": {
"type": "string",
"description": "",
"enum": [
"crew_function",
"transport_function",
"remark",
"shift"
]
},
"amount": {
"type": "integer",
"description": ""
},
"is_plannable": {
"type": "boolean",
"description": "If yes, crew members scheduled on this shift will be shown as available for other functions."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectFunctionResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"cost_rate",
"cost_accommodation",
"cost_catering",
"cost_travel",
"cost_other",
"price_rate",
"price_accommodation",
"price_catering",
"price_travel",
"price_other",
"project",
"subproject",
"is_template",
"group",
"name_external",
"name",
"travel_time_before",
"travel_time_after",
"use_travel_time_from_location",
"use_distance_from_location",
"usageperiod_start",
"planperiod_start_schedule_is_start",
"usageperiod_start_schedule_is_start",
"planperiod_end_schedule_is_start",
"usageperiod_end_schedule_is_start",
"usageperiod_end",
"planperiod_start",
"planperiod_end",
"type",
"duration",
"amount",
"break",
"distance",
"twoway",
"taxclass",
"ledger",
"ledger_debit",
"order",
"remark_client",
"remark_planner",
"remark_crew",
"in_financial",
"in_planning",
"is_plannable",
"recurrence_group",
"recurrence_enddate",
"recurrence_interval_unit",
"recurrence_interval",
"recurrence_weekdays",
"price_fixed",
"price_variable",
"costs_fixed",
"costs_variable",
"price_total",
"costs_total",
"tags",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD. Name on packing slips."
},
"cost_rate": {
"type": "string",
"description": "",
"example": "/rates/0"
},
"cost_accommodation": {
"type": "number",
"description": ""
},
"cost_catering": {
"type": "number",
"description": ""
},
"cost_travel": {
"type": "number",
"description": ""
},
"cost_other": {
"type": "number",
"description": ""
},
"price_rate": {
"type": "string",
"description": "",
"example": "/rates/0"
},
"price_accommodation": {
"type": "number",
"description": ""
},
"price_catering": {
"type": "number",
"description": ""
},
"price_travel": {
"type": "number",
"description": ""
},
"price_other": {
"type": "number",
"description": ""
},
"project": {
"type": "string",
"description": "",
"example": "/projects/0"
},
"subproject": {
"type": "string",
"description": "",
"example": "/subprojects/0"
},
"is_template": {
"type": "boolean",
"description": ""
},
"group": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectfunctiongroups/0"
},
"name_external": {
"type": "string",
"description": "Name on financial documents."
},
"name": {
"type": "string",
"description": "Name on packing lists."
},
"travel_time_before": {
"type": [
"number",
"null"
],
"description": ""
},
"travel_time_after": {
"type": [
"number",
"null"
],
"description": ""
},
"use_travel_time_from_location": {
"type": "boolean",
"description": ""
},
"use_distance_from_location": {
"type": "boolean",
"description": ""
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_start_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"End time",
"Start time"
]
},
"usageperiod_start_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"End time",
"Start time"
]
},
"planperiod_end_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"End time",
"Start time"
]
},
"usageperiod_end_schedule_is_start": {
"type": "string",
"description": "",
"enum": [
"End time",
"Start time"
]
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"type": {
"type": "string",
"description": "",
"enum": [
"crew_function",
"transport_function",
"remark",
"shift"
]
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"amount": {
"type": "integer",
"description": ""
},
"break": {
"type": [
"number",
"null"
],
"description": ""
},
"distance": {
"type": "number",
"description": ""
},
"twoway": {
"type": "boolean",
"description": ""
},
"taxclass": {
"type": [
"string",
"null"
],
"description": "",
"example": "/taxclasses/0"
},
"ledger": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"ledger_debit": {
"type": [
"string",
"null"
],
"description": "",
"example": "/ledgercodes/0"
},
"order": {
"type": "string",
"description": ""
},
"remark_client": {
"type": "string",
"description": ""
},
"remark_planner": {
"type": "string",
"description": ""
},
"remark_crew": {
"type": "string",
"description": ""
},
"in_financial": {
"type": "boolean",
"description": ""
},
"in_planning": {
"type": "boolean",
"description": ""
},
"is_plannable": {
"type": "boolean",
"description": "If yes, crew members scheduled on this shift will be shown as available for other functions."
},
"recurrence_group": {
"type": "integer",
"description": "Identification which recurrences belong together."
},
"recurrence_enddate": {
"type": [
"string",
"null"
],
"description": "Date the recurrence ends."
},
"recurrence_interval_unit": {
"type": "string",
"description": "Period between each recurrence. E.g. every x day/week/month/year.",
"enum": [
"once",
"days",
"weeks",
"months",
"years",
"specific_days"
]
},
"recurrence_interval": {
"type": "integer",
"description": "Number of days/weeks/months/years between each recurrence. E.g. every 2 weeks."
},
"recurrence_weekdays": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD. Use the integers: 0 = Monday, 1 = Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday."
},
"price_fixed": {
"type": "number",
"description": "GENERATED FIELD."
},
"price_variable": {
"type": "number",
"description": "GENERATED FIELD."
},
"costs_fixed": {
"type": "number",
"description": "GENERATED FIELD."
},
"costs_variable": {
"type": "number",
"description": "GENERATED FIELD."
},
"price_total": {
"type": "number",
"description": "GENERATED FIELD. Total price based on duration and selected price rate."
},
"costs_total": {
"type": "number",
"description": "GENERATED FIELD. Total costs based on duration and chosen cost rate."
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectRequestEquipmentRequest": {
"type": "object",
"required": [],
"properties": {
"quantity": {
"type": "integer",
"description": ""
},
"quantity_total": {
"type": "integer",
"description": ""
},
"is_comment": {
"type": "boolean",
"description": ""
},
"is_kit": {
"type": "boolean",
"description": ""
},
"discount": {
"type": "number",
"description": ""
},
"linked_equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"name": {
"type": "string",
"description": ""
},
"external_remark": {
"type": "string",
"description": ""
},
"parent": {
"type": [
"string",
"null"
],
"description": "The combination it is part of.",
"example": "/projectrequestequipment/0"
},
"unit_price": {
"type": "number",
"description": ""
},
"factor": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
}
}
},
"ProjectRequestEquipmentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"quantity",
"quantity_total",
"is_comment",
"is_kit",
"discount",
"linked_equipment",
"name",
"external_remark",
"parent",
"unit_price",
"project_request",
"factor",
"order"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"quantity": {
"type": "integer",
"description": ""
},
"quantity_total": {
"type": "integer",
"description": ""
},
"is_comment": {
"type": "boolean",
"description": ""
},
"is_kit": {
"type": "boolean",
"description": ""
},
"discount": {
"type": "number",
"description": ""
},
"linked_equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"name": {
"type": "string",
"description": ""
},
"external_remark": {
"type": "string",
"description": ""
},
"parent": {
"type": [
"string",
"null"
],
"description": "The combination it is part of.",
"example": "/projectrequestequipment/0"
},
"unit_price": {
"type": "number",
"description": ""
},
"project_request": {
"type": "string",
"description": "",
"example": "/projectrequests/0"
},
"factor": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
}
}
},
"ProjectRequestRequest": {
"type": "object",
"required": [
"planperiod_end",
"planperiod_start"
],
"properties": {
"linked_contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact_mailing_number": {
"type": "string",
"description": ""
},
"contact_mailing_country": {
"type": "string",
"description": ""
},
"contact_name": {
"type": "string",
"description": ""
},
"contact_mailing_postalcode": {
"type": "string",
"description": ""
},
"contact_phone": {
"type": "string",
"description": ""
},
"contact_mailing_city": {
"type": "string",
"description": ""
},
"contact_mailing_street": {
"type": "string",
"description": ""
},
"contact_person_lastname": {
"type": "string",
"description": ""
},
"contact_person_email": {
"type": "string",
"description": "",
"format": "email"
},
"contact_person_middle_name": {
"type": "string",
"description": ""
},
"contact_person_first_name": {
"type": "string",
"description": ""
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"is_paid": {
"type": "boolean",
"description": ""
},
"language": {
"type": "string",
"description": ""
},
"in": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"out": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"location_mailing_number": {
"type": "string",
"description": ""
},
"location_mailing_country": {
"type": "string",
"description": ""
},
"location_name": {
"type": "string",
"description": ""
},
"location_mailing_postalcode": {
"type": "string",
"description": ""
},
"location_mailing_city": {
"type": "string",
"description": ""
},
"location_mailing_street": {
"type": "string",
"description": ""
},
"location_phone": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"external_reference": {
"type": "integer",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"planperiod_end": {
"type": "string",
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": "string",
"description": "",
"format": "date-time"
},
"price": {
"type": "number",
"description": ""
}
}
},
"ProjectRequestResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"linked_contact",
"contact_mailing_number",
"contact_mailing_country",
"contact_name",
"contact_mailing_postalcode",
"contact_phone",
"contact_mailing_city",
"contact_mailing_street",
"linked_contact_person",
"contact_person_lastname",
"contact_person_email",
"contact_person_middle_name",
"contact_person_first_name",
"usageperiod_end",
"usageperiod_start",
"is_paid",
"language",
"in",
"out",
"linked_location",
"location_mailing_number",
"location_mailing_country",
"location_name",
"location_mailing_postalcode",
"location_mailing_city",
"location_mailing_street",
"location_phone",
"name",
"external_reference",
"remark",
"planperiod_end",
"planperiod_start",
"price",
"linked_project",
"source",
"status"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"linked_contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact_mailing_number": {
"type": "string",
"description": ""
},
"contact_mailing_country": {
"type": "string",
"description": ""
},
"contact_name": {
"type": "string",
"description": ""
},
"contact_mailing_postalcode": {
"type": "string",
"description": ""
},
"contact_phone": {
"type": "string",
"description": ""
},
"contact_mailing_city": {
"type": "string",
"description": ""
},
"contact_mailing_street": {
"type": "string",
"description": ""
},
"linked_contact_person": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"contact_person_lastname": {
"type": "string",
"description": ""
},
"contact_person_email": {
"type": "string",
"description": "",
"format": "email"
},
"contact_person_middle_name": {
"type": "string",
"description": ""
},
"contact_person_first_name": {
"type": "string",
"description": ""
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"is_paid": {
"type": "boolean",
"description": ""
},
"language": {
"type": "string",
"description": ""
},
"in": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"out": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"linked_location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"location_mailing_number": {
"type": "string",
"description": ""
},
"location_mailing_country": {
"type": "string",
"description": ""
},
"location_name": {
"type": "string",
"description": ""
},
"location_mailing_postalcode": {
"type": "string",
"description": ""
},
"location_mailing_city": {
"type": "string",
"description": ""
},
"location_mailing_street": {
"type": "string",
"description": ""
},
"location_phone": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"external_reference": {
"type": "integer",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"planperiod_end": {
"type": "string",
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": "string",
"description": "",
"format": "date-time"
},
"price": {
"type": "number",
"description": ""
},
"linked_project": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projects/0"
},
"source": {
"type": "string",
"description": "",
"enum": [
"rentaround",
"rentman",
"zoef",
"api"
]
},
"status": {
"type": "string",
"description": "",
"enum": [
"accepted",
"declined",
"open"
]
}
}
},
"ProjectRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"reference": {
"type": "string",
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"location",
"refundabledeposit",
"deposit_status",
"customer",
"loc_contact",
"cust_contact",
"project_type",
"name",
"reference",
"number",
"account_manager",
"color",
"conditions",
"project_total_price",
"project_total_price_cancelled",
"project_rental_price",
"project_sale_price",
"project_crew_price",
"project_transport_price",
"project_other_price",
"project_insurance_price",
"project_services_price",
"estimated_cost",
"planned_cost",
"actual_cost",
"already_invoiced",
"tags",
"usageperiod_start",
"usageperiod_end",
"planperiod_start",
"planperiod_end",
"weight",
"power",
"current",
"equipment_period_from",
"equipment_period_to",
"purchasecosts",
"volume",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"refundabledeposit": {
"type": "number",
"description": ""
},
"deposit_status": {
"type": "string",
"description": "",
"enum": [
"no_deposit_paid",
"deposit_paid",
"deposit_returned"
]
},
"customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"loc_contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"cust_contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"project_type": {
"type": "string",
"description": "",
"example": "/projecttypes/0"
},
"name": {
"type": "string",
"description": ""
},
"reference": {
"type": "string",
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"account_manager": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"color": {
"type": "string",
"description": ""
},
"conditions": {
"type": "string",
"description": ""
},
"project_total_price": {
"type": "number",
"description": "GENERATED FIELD. Total of not-canceled subprojects. Not visible in collection responses unless explicitly requested."
},
"project_total_price_cancelled": {
"type": "number",
"description": "GENERATED FIELD. Total cancelled projects. Not visible in collection responses unless explicitly requested."
},
"project_rental_price": {
"type": "number",
"description": "GENERATED FIELD. Total price rental equipment. Not visible in collection responses unless explicitly requested."
},
"project_sale_price": {
"type": "number",
"description": "GENERATED FIELD. Total price sales equipment. Not visible in collection responses unless explicitly requested."
},
"project_crew_price": {
"type": "number",
"description": "GENERATED FIELD. Total price crew. Not visible in collection responses unless explicitly requested."
},
"project_transport_price": {
"type": "number",
"description": "GENERATED FIELD. Total price transport. Not visible in collection responses unless explicitly requested."
},
"project_other_price": {
"type": "number",
"description": "GENERATED FIELD. Total price other costs. Not visible in collection responses unless explicitly requested."
},
"project_insurance_price": {
"type": "number",
"description": "GENERATED FIELD. Total price insurance. Not visible in collection responses unless explicitly requested."
},
"project_services_price": {
"type": "number",
"description": "GENERATED FIELD. Total price services. Not visible in collection responses unless explicitly requested."
},
"estimated_cost": {
"type": "number",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"planned_cost": {
"type": "number",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"actual_cost": {
"type": "number",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"already_invoiced": {
"type": "number",
"description": "GENERATED FIELD."
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"weight": {
"type": "number",
"description": "GENERATED FIELD."
},
"power": {
"type": "number",
"description": "GENERATED FIELD."
},
"current": {
"type": "number",
"description": "GENERATED FIELD."
},
"equipment_period_from": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"equipment_period_to": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"purchasecosts": {
"type": "number",
"description": "GENERATED FIELD."
},
"volume": {
"type": "number",
"description": "GENERATED FIELD."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectStatusRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
}
}
},
"ProjectStatusResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
}
}
},
"ProjectTypeRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"regular",
"supplier",
"transfer",
"shifts"
]
}
}
},
"ProjectTypeResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"color",
"type"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"regular",
"supplier",
"transfer",
"shifts"
]
}
}
},
"ProjectVehicleRequest": {
"type": "object",
"required": [
"vehicle"
],
"properties": {
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
},
"transport": {
"type": "string",
"description": "",
"enum": [
"No transport",
"Round trip",
"Only way there",
"Only way back"
]
},
"vehicle": {
"type": "string",
"description": "",
"example": "/vehicles/0"
},
"planningperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planningperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"remark": {
"type": "string",
"description": ""
},
"remark_planner": {
"type": "string",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"ProjectVehicleResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"cost_rate",
"function",
"transport",
"vehicle",
"planningperiod_start",
"planningperiod_end",
"remark",
"remark_planner",
"costs",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
},
"function": {
"type": "string",
"description": "",
"example": "/projectfunctions/0"
},
"transport": {
"type": "string",
"description": "",
"enum": [
"No transport",
"Round trip",
"Only way there",
"Only way back"
]
},
"vehicle": {
"type": "string",
"description": "",
"example": "/vehicles/0"
},
"planningperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planningperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"remark": {
"type": "string",
"description": ""
},
"remark_planner": {
"type": "string",
"description": ""
},
"costs": {
"type": "number",
"description": "GENERATED FIELD."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"PurchaseOrderCostRequest": {
"type": "object",
"required": [],
"properties": {
"costitem": {
"type": "integer",
"description": ""
},
"costitemtype": {
"type": "string",
"description": "",
"enum": [
"Inhuur",
"Cost",
"Service",
"PurchaseOrderGlobalCost",
"Planningpersoneel"
]
},
"approved_amount": {
"type": "number",
"description": ""
}
}
},
"PurchaseOrderCostResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"purchase_order",
"costitem",
"costitemtype",
"approved_amount",
"project",
"underlying_cost_amount",
"underlying_cost_amount_tax",
"underlying_cost_amount_with_tax",
"quantity"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"purchase_order": {
"type": "string",
"description": "",
"example": "/purchaseorders/0"
},
"costitem": {
"type": "integer",
"description": ""
},
"costitemtype": {
"type": "string",
"description": "",
"enum": [
"Inhuur",
"Cost",
"Service",
"PurchaseOrderGlobalCost",
"Planningpersoneel"
]
},
"approved_amount": {
"type": "number",
"description": ""
},
"project": {
"type": "string",
"description": "GENERATED FIELD."
},
"underlying_cost_amount": {
"type": "number",
"description": "GENERATED FIELD."
},
"underlying_cost_amount_tax": {
"type": "number",
"description": "GENERATED FIELD."
},
"underlying_cost_amount_with_tax": {
"type": "number",
"description": "GENERATED FIELD."
},
"quantity": {
"type": "integer",
"description": "GENERATED FIELD."
}
}
},
"PurchaseOrderGlobalCostRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"unit_purchase_cost": {
"type": "number",
"description": ""
},
"quantity": {
"type": "integer",
"description": ""
},
"taxclass": {
"type": [
"string",
"null"
],
"description": "",
"example": "/taxclasses/0"
}
}
},
"PurchaseOrderGlobalCostResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"purchase_order",
"name",
"unit_purchase_cost",
"quantity",
"taxclass"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"purchase_order": {
"type": "string",
"description": "",
"example": "/purchaseorders/0"
},
"name": {
"type": "string",
"description": ""
},
"unit_purchase_cost": {
"type": "number",
"description": ""
},
"quantity": {
"type": "integer",
"description": ""
},
"taxclass": {
"type": [
"string",
"null"
],
"description": "",
"example": "/taxclasses/0"
}
}
},
"PurchaseOrderRequest": {
"type": "object",
"required": [
"previous_status"
],
"properties": {
"filename": {
"type": "string",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"owner": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"date_of_issue": {
"type": [
"string",
"null"
],
"description": ""
},
"delivery_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"description": {
"type": "string",
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"approval_status": {
"type": "string",
"description": "",
"enum": [
"draft",
"pending_approval",
"approved",
"rejected",
"sent",
"completed",
"cancelled"
]
},
"previous_status": {
"type": "string",
"description": "",
"enum": [
"draft",
"pending_approval",
"approved",
"rejected",
"sent",
"completed",
"cancelled"
]
},
"approved_amount": {
"type": "number",
"description": ""
},
"supplier": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact_person": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"delivery_type": {
"type": "string",
"description": "",
"enum": [
"Pick up",
"Delivery at warehouse",
"Delivery at location",
"Not applicable/No delivery"
]
},
"delivery_location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"delivery_location_person": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"delivery_warehouse": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"accounting_code": {
"type": "string",
"description": "External identifier used for integrations with accounting software."
},
"export_status": {
"type": "string",
"description": "",
"enum": [
"failed",
"ignored",
"inprogress",
"new",
"processed"
]
},
"export_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"export_message": {
"type": "string",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"PurchaseOrderResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"filename",
"subject",
"owner",
"date_of_issue",
"delivery_date",
"description",
"number",
"approval_status",
"previous_status",
"approved_amount",
"supplier",
"contact_person",
"delivery_type",
"delivery_location",
"delivery_location_person",
"delivery_warehouse",
"accounting_code",
"export_status",
"export_date",
"export_message",
"tags",
"underlying_cost_amount",
"underlying_cost_amount_tax",
"underlying_cost_amount_with_tax",
"approved_by",
"approved_at",
"projects_json",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"filename": {
"type": "string",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"owner": {
"type": "string",
"description": "",
"example": "/crew/0"
},
"date_of_issue": {
"type": [
"string",
"null"
],
"description": ""
},
"delivery_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"description": {
"type": "string",
"description": ""
},
"number": {
"type": "string",
"description": ""
},
"approval_status": {
"type": "string",
"description": "",
"enum": [
"draft",
"pending_approval",
"approved",
"rejected",
"sent",
"completed",
"cancelled"
]
},
"previous_status": {
"type": "string",
"description": "",
"enum": [
"draft",
"pending_approval",
"approved",
"rejected",
"sent",
"completed",
"cancelled"
]
},
"approved_amount": {
"type": "number",
"description": ""
},
"supplier": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact_person": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"delivery_type": {
"type": "string",
"description": "",
"enum": [
"Pick up",
"Delivery at warehouse",
"Delivery at location",
"Not applicable/No delivery"
]
},
"delivery_location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"delivery_location_person": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"delivery_warehouse": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"accounting_code": {
"type": "string",
"description": "External identifier used for integrations with accounting software."
},
"export_status": {
"type": "string",
"description": "",
"enum": [
"failed",
"ignored",
"inprogress",
"new",
"processed"
]
},
"export_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"export_message": {
"type": "string",
"description": ""
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"underlying_cost_amount": {
"type": "number",
"description": "GENERATED FIELD."
},
"underlying_cost_amount_tax": {
"type": "number",
"description": "GENERATED FIELD."
},
"underlying_cost_amount_with_tax": {
"type": "number",
"description": "GENERATED FIELD."
},
"approved_by": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"example": "/crew/0"
},
"approved_at": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD."
},
"projects_json": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"QuotationRequest": {
"type": "object",
"required": [],
"properties": {
"number": {
"type": "string",
"description": ""
},
"customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"date": {
"type": [
"string",
"null"
],
"description": ""
},
"expiration_date": {
"type": [
"string",
"null"
],
"description": "The date on which this quotation expires."
},
"version": {
"type": "integer",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"show_tax": {
"type": "boolean",
"description": ""
},
"filename": {
"type": "string",
"description": ""
}
}
},
"QuotationResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"number",
"customer",
"contact",
"date",
"expiration_date",
"version",
"subject",
"show_tax",
"project",
"filename",
"project_total_price",
"project_total_price_cancelled",
"project_rental_price",
"project_sale_price",
"project_crew_price",
"project_transport_price",
"project_other_price",
"project_insurance_price",
"project_services_price",
"price",
"price_invat",
"vat_amount",
"tags"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"number": {
"type": "string",
"description": ""
},
"customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"date": {
"type": [
"string",
"null"
],
"description": ""
},
"expiration_date": {
"type": [
"string",
"null"
],
"description": "The date on which this quotation expires."
},
"version": {
"type": "integer",
"description": ""
},
"subject": {
"type": "string",
"description": ""
},
"show_tax": {
"type": "boolean",
"description": ""
},
"project": {
"type": "string",
"description": "",
"example": "/projects/0"
},
"filename": {
"type": "string",
"description": ""
},
"project_total_price": {
"type": "number",
"description": "GENERATED FIELD. Total of not-canceled subprojects. Not visible in collection responses unless explicitly requested."
},
"project_total_price_cancelled": {
"type": "number",
"description": "GENERATED FIELD. Total cancelled projects. Not visible in collection responses unless explicitly requested."
},
"project_rental_price": {
"type": "number",
"description": "GENERATED FIELD. Total price rental equipment. Not visible in collection responses unless explicitly requested."
},
"project_sale_price": {
"type": "number",
"description": "GENERATED FIELD. Total price sales equipment. Not visible in collection responses unless explicitly requested."
},
"project_crew_price": {
"type": "number",
"description": "GENERATED FIELD. Total price crew. Not visible in collection responses unless explicitly requested."
},
"project_transport_price": {
"type": "number",
"description": "GENERATED FIELD. Total price transport. Not visible in collection responses unless explicitly requested."
},
"project_other_price": {
"type": "number",
"description": "GENERATED FIELD. Total price other costs. Not visible in collection responses unless explicitly requested."
},
"project_insurance_price": {
"type": "number",
"description": "GENERATED FIELD. Total price insurance. Not visible in collection responses unless explicitly requested."
},
"project_services_price": {
"type": "number",
"description": "GENERATED FIELD. Total price services. Not visible in collection responses unless explicitly requested."
},
"price": {
"type": "number",
"description": "GENERATED FIELD."
},
"price_invat": {
"type": "number",
"description": "GENERATED FIELD."
},
"vat_amount": {
"type": "number",
"description": "GENERATED FIELD."
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
}
}
},
"CrewRateFactorRequest": {
"type": "object",
"required": [],
"properties": {
"from": {
"type": [
"number",
"null"
],
"description": ""
},
"to": {
"type": [
"number",
"null"
],
"description": ""
},
"variable": {
"type": "number",
"description": ""
},
"fixed": {
"type": "number",
"description": ""
}
}
},
"CrewRateFactorResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"rate_id",
"from",
"to",
"variable",
"fixed"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"rate_id": {
"type": "string",
"description": "",
"example": "/rates/0"
},
"from": {
"type": [
"number",
"null"
],
"description": ""
},
"to": {
"type": [
"number",
"null"
],
"description": ""
},
"variable": {
"type": "number",
"description": ""
},
"fixed": {
"type": "number",
"description": ""
}
}
},
"CrewRateRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"archived": {
"type": "boolean",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"price",
"cost"
]
},
"subtype": {
"type": "string",
"description": "",
"enum": [
"global",
"flat",
"temp"
]
}
}
},
"CrewRateResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"archived",
"type",
"subtype"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"archived": {
"type": "boolean",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"price",
"cost"
]
},
"subtype": {
"type": "string",
"description": "",
"enum": [
"global",
"flat",
"temp"
]
}
}
},
"RepairRequest": {
"type": "object",
"required": [],
"properties": {
"internal_name": {
"type": "string",
"description": ""
},
"serialnumber": {
"type": [
"string",
"null"
],
"description": "",
"example": "/serialnumbers/0"
},
"reporter": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"assignee": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"external_repairer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"number": {
"type": "string",
"description": ""
},
"repairperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"repairperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"amount": {
"type": "integer",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"repair_costs": {
"type": "number",
"description": ""
},
"is_usable": {
"type": "string",
"description": "",
"enum": [
"take_from_stock",
"keep_usable"
]
},
"costs_charged_to_customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/costs/0"
},
"subproject": {
"type": [
"string",
"null"
],
"description": "",
"example": "/subprojects/0"
},
"stock_location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"repair_status": {
"type": "string",
"description": "",
"enum": [
"in-progress",
"completed",
"unrepairable"
]
},
"unrepairable_of": {
"type": [
"string",
"null"
],
"description": "",
"example": "/repairs/0"
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"RepairResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"internal_name",
"equipment",
"serialnumber",
"reporter",
"assignee",
"external_repairer",
"number",
"repairperiod_start",
"repairperiod_end",
"amount",
"remark",
"repair_costs",
"is_usable",
"costs_charged_to_customer",
"subproject",
"stock_location",
"repair_status",
"unrepairable_of",
"tags",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"internal_name": {
"type": "string",
"description": ""
},
"equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"serialnumber": {
"type": [
"string",
"null"
],
"description": "",
"example": "/serialnumbers/0"
},
"reporter": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"assignee": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"external_repairer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"number": {
"type": "string",
"description": ""
},
"repairperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"repairperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"amount": {
"type": "integer",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"repair_costs": {
"type": "number",
"description": ""
},
"is_usable": {
"type": "string",
"description": "",
"enum": [
"take_from_stock",
"keep_usable"
]
},
"costs_charged_to_customer": {
"type": [
"string",
"null"
],
"description": "",
"example": "/costs/0"
},
"subproject": {
"type": [
"string",
"null"
],
"description": "",
"example": "/subprojects/0"
},
"stock_location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"repair_status": {
"type": "string",
"description": "",
"enum": [
"in-progress",
"completed",
"unrepairable"
]
},
"unrepairable_of": {
"type": [
"string",
"null"
],
"description": "",
"example": "/repairs/0"
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"SerialNumberRequest": {
"type": "object",
"required": [],
"properties": {
"serial": {
"type": "string",
"description": "The manufacturer serial number of the equipment."
},
"purchasedate": {
"type": [
"string",
"null"
],
"description": ""
},
"depreciation_monthly": {
"type": "number",
"description": ""
},
"book_value": {
"type": "number",
"description": ""
},
"residual_value": {
"type": "number",
"description": ""
},
"purchase_costs": {
"type": "number",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"ref": {
"type": "string",
"description": "Internal reference of a specific serial number."
},
"asset_location": {
"type": "string",
"description": "",
"example": "/stocklocations/0"
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"SerialNumberResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"equipment",
"serial",
"purchasedate",
"depreciation_monthly",
"book_value",
"residual_value",
"purchase_costs",
"active",
"remark",
"ref",
"asset_location",
"image",
"current_book_value",
"next_inspection",
"qrcodes",
"tags",
"last_subproject",
"sealed",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"serial": {
"type": "string",
"description": "The manufacturer serial number of the equipment."
},
"purchasedate": {
"type": [
"string",
"null"
],
"description": ""
},
"depreciation_monthly": {
"type": "number",
"description": ""
},
"book_value": {
"type": "number",
"description": ""
},
"residual_value": {
"type": "number",
"description": ""
},
"purchase_costs": {
"type": "number",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"ref": {
"type": "string",
"description": "Internal reference of a specific serial number."
},
"asset_location": {
"type": "string",
"description": "",
"example": "/stocklocations/0"
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"current_book_value": {
"type": "number",
"description": "GENERATED FIELD."
},
"next_inspection": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD."
},
"qrcodes": {
"type": "string",
"description": "GENERATED FIELD."
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"last_subproject": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"example": "/subprojects/0"
},
"sealed": {
"type": "boolean",
"description": "GENERATED FIELD."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"StatusRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
}
}
},
"StatusResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
}
}
},
"StockLocationRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"city": {
"type": "string",
"description": ""
},
"street": {
"type": "string",
"description": ""
},
"house_number": {
"type": "string",
"description": ""
},
"postal_code": {
"type": "string",
"description": ""
},
"state_province": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"active": {
"type": "boolean",
"description": ""
},
"type": {
"type": "string",
"description": "Projects can only be planned from warehouses. Storage locations are used as (temporary) storage and deliver equipment to warehouses. You can change the number of paid warehouses in your license. Storage locations are free of charge.",
"enum": [
"plannable",
"nonplannable"
]
},
"color": {
"type": "string",
"description": ""
},
"in_archive": {
"type": "boolean",
"description": "This stock location is archived. This means that it cannot be used in equipment planning."
}
}
},
"StockLocationResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"city",
"street",
"house_number",
"postal_code",
"state_province",
"country",
"active",
"type",
"color",
"in_archive"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"city": {
"type": "string",
"description": ""
},
"street": {
"type": "string",
"description": ""
},
"house_number": {
"type": "string",
"description": ""
},
"postal_code": {
"type": "string",
"description": ""
},
"state_province": {
"type": "string",
"description": ""
},
"country": {
"type": "string",
"description": "",
"enum": [
"af",
"al",
"dz",
"as",
"ad",
"ao",
"ai",
"ag",
"ar",
"am",
"aw",
"au",
"at",
"az",
"bs",
"bh",
"bd",
"bb",
"by",
"be",
"bz",
"bj",
"bm",
"bt",
"bo",
"bq",
"ba",
"bw",
"br",
"vg",
"bn",
"bg",
"bf",
"bi",
"kh",
"cm",
"ca",
"cv",
"ky",
"cf",
"td",
"cl",
"cn",
"cx",
"cc",
"co",
"km",
"cd",
"cg",
"ck",
"cr",
"hr",
"cu",
"cw",
"cy",
"cz",
"dk",
"dj",
"do",
"ec",
"eg",
"sv",
"gq",
"er",
"ee",
"et",
"fk",
"fo",
"fj",
"fi",
"fr",
"gf",
"pf",
"ga",
"gm",
"ge",
"de",
"gh",
"gi",
"gr",
"gl",
"gd",
"gp",
"gu",
"gt",
"gg",
"gn",
"gw",
"gy",
"ht",
"hn",
"hk",
"hu",
"is",
"in",
"id",
"ir",
"iq",
"ie",
"im",
"il",
"it",
"ci",
"jm",
"jp",
"je",
"jo",
"kz",
"ke",
"ki",
"xk",
"kw",
"kg",
"la",
"lv",
"lb",
"ls",
"lr",
"ly",
"li",
"lt",
"lu",
"mo",
"mk",
"mg",
"mw",
"my",
"mv",
"ml",
"mt",
"mh",
"mq",
"mr",
"mu",
"yt",
"mx",
"fm",
"md",
"mc",
"mn",
"me",
"ms",
"ma",
"mz",
"mm",
"na",
"nr",
"np",
"an",
"nc",
"nz",
"ni",
"ne",
"ng",
"nu",
"nf",
"kp",
"mp",
"no",
"om",
"pk",
"pw",
"ps",
"pa",
"pg",
"py",
"pe",
"ph",
"pn",
"pl",
"pt",
"pr",
"qa",
"re",
"ro",
"ru",
"rw",
"sh",
"vc",
"ws",
"sm",
"sa",
"sn",
"rs",
"sc",
"sl",
"sg",
"sk",
"si",
"sb",
"so",
"za",
"gs",
"kr",
"ss",
"es",
"lk",
"bl",
"kn",
"lc",
"pm",
"mf",
"sx",
"sd",
"sr",
"sj",
"sz",
"se",
"ch",
"sy",
"st",
"tw",
"tj",
"tz",
"th",
"nl",
"tl",
"tg",
"tk",
"to",
"tt",
"tn",
"tr",
"tm",
"tc",
"tv",
"us",
"ug",
"ua",
"ae",
"gb",
"uy",
"uz",
"vu",
"va",
"ve",
"vn",
"vi",
"wf",
"eh",
"ye",
"zm",
"zw",
"ax"
]
},
"active": {
"type": "boolean",
"description": ""
},
"type": {
"type": "string",
"description": "Projects can only be planned from warehouses. Storage locations are used as (temporary) storage and deliver equipment to warehouses. You can change the number of paid warehouses in your license. Storage locations are free of charge.",
"enum": [
"plannable",
"nonplannable"
]
},
"color": {
"type": "string",
"description": ""
},
"in_archive": {
"type": "boolean",
"description": "This stock location is archived. This means that it cannot be used in equipment planning."
}
}
},
"StockMovementRequest": {
"type": "object",
"required": [
"date"
],
"properties": {
"amount": {
"type": "integer",
"description": ""
},
"projectequipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectequipment/0"
},
"description": {
"type": "string",
"description": ""
},
"details": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": "",
"format": "date-time"
},
"stock_location": {
"type": "string",
"description": "",
"example": "/stocklocations/0"
},
"api_client": {
"type": "string",
"description": ""
}
}
},
"StockMovementResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"amount",
"equipment",
"projectequipment",
"description",
"details",
"date",
"type",
"stock_location",
"api_client"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"amount": {
"type": "integer",
"description": ""
},
"equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"projectequipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectequipment/0"
},
"description": {
"type": "string",
"description": ""
},
"details": {
"type": "string",
"description": ""
},
"date": {
"type": "string",
"description": "",
"format": "date-time"
},
"type": {
"type": "string",
"description": "",
"enum": [
"manual",
"equipment_lost",
"equipment_found",
"serial_created",
"serial_deleted",
"serial_deactivated",
"serial_activated_or_found",
"serial_lost",
"stock_corrected_counting_serials",
"equipment_imported",
"initial_mutation",
"countjob_correction",
"serial_transferred",
"case_transfer",
"bulk_transfer",
"unrepairable",
"unrepairable_undo"
]
},
"stock_location": {
"type": "string",
"description": "",
"example": "/stocklocations/0"
},
"api_client": {
"type": "string",
"description": ""
}
}
},
"SubprojectRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"SubprojectResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"project",
"order",
"name",
"status",
"is_template",
"location",
"loc_contact",
"insurance_rate",
"discount_rental",
"discount_sale",
"discount_crew",
"discount_transport",
"discount_additional_costs",
"discount_services",
"discount_subproject",
"discount_fixed",
"discount_fixed_amount",
"fixed_price",
"in_planning",
"in_financial",
"asset_location_from",
"project_total_price",
"project_total_price_cancelled",
"project_rental_price",
"project_sale_price",
"project_crew_price",
"project_transport_price",
"project_other_price",
"project_insurance_price",
"project_services_price",
"estimated_cost",
"planned_cost",
"actual_cost",
"already_invoiced",
"usageperiod_start",
"usageperiod_end",
"planperiod_start",
"planperiod_end",
"weight",
"power",
"current",
"purchasecosts",
"volume",
"equipment_period_from",
"equipment_period_to",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"project": {
"type": "string",
"description": "",
"example": "/projects/0"
},
"order": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"status": {
"type": "string",
"description": "",
"example": "/statuses/0"
},
"is_template": {
"type": "boolean",
"description": ""
},
"location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"loc_contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"insurance_rate": {
"type": "number",
"description": ""
},
"discount_rental": {
"type": "number",
"description": ""
},
"discount_sale": {
"type": "number",
"description": ""
},
"discount_crew": {
"type": "number",
"description": ""
},
"discount_transport": {
"type": "number",
"description": ""
},
"discount_additional_costs": {
"type": "number",
"description": ""
},
"discount_services": {
"type": "number",
"description": ""
},
"discount_subproject": {
"type": "number",
"description": ""
},
"discount_fixed": {
"type": "boolean",
"description": ""
},
"discount_fixed_amount": {
"type": "number",
"description": ""
},
"fixed_price": {
"type": "boolean",
"description": ""
},
"in_planning": {
"type": "boolean",
"description": ""
},
"in_financial": {
"type": "boolean",
"description": ""
},
"asset_location_from": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"project_total_price": {
"type": "number",
"description": "GENERATED FIELD. Total of not-canceled subprojects. Not visible in collection responses unless explicitly requested."
},
"project_total_price_cancelled": {
"type": "number",
"description": "GENERATED FIELD. Total cancelled projects. Not visible in collection responses unless explicitly requested."
},
"project_rental_price": {
"type": "number",
"description": "GENERATED FIELD. Total price rental equipment. Not visible in collection responses unless explicitly requested."
},
"project_sale_price": {
"type": "number",
"description": "GENERATED FIELD. Total price sales equipment. Not visible in collection responses unless explicitly requested."
},
"project_crew_price": {
"type": "number",
"description": "GENERATED FIELD. Total price crew. Not visible in collection responses unless explicitly requested."
},
"project_transport_price": {
"type": "number",
"description": "GENERATED FIELD. Total price transport. Not visible in collection responses unless explicitly requested."
},
"project_other_price": {
"type": "number",
"description": "GENERATED FIELD. Total price other costs. Not visible in collection responses unless explicitly requested."
},
"project_insurance_price": {
"type": "number",
"description": "GENERATED FIELD. Total price insurance. Not visible in collection responses unless explicitly requested."
},
"project_services_price": {
"type": "number",
"description": "GENERATED FIELD. Total price services. Not visible in collection responses unless explicitly requested."
},
"estimated_cost": {
"type": "number",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"planned_cost": {
"type": "number",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"actual_cost": {
"type": "number",
"description": "GENERATED FIELD. Not visible in collection responses unless explicitly requested."
},
"already_invoiced": {
"type": "number",
"description": "GENERATED FIELD."
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"weight": {
"type": "number",
"description": "GENERATED FIELD."
},
"power": {
"type": "number",
"description": "GENERATED FIELD."
},
"current": {
"type": "number",
"description": "GENERATED FIELD."
},
"purchasecosts": {
"type": "number",
"description": "GENERATED FIELD."
},
"volume": {
"type": "number",
"description": "GENERATED FIELD."
},
"equipment_period_from": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"equipment_period_to": {
"type": [
"string",
"null"
],
"description": "GENERATED FIELD.",
"format": "date-time"
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"SubrentalEquipmentRequest": {
"type": "object",
"required": [],
"properties": {
"equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/subrentalequipment/0"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"name": {
"type": "string",
"description": ""
},
"quantity": {
"type": "integer",
"description": ""
},
"quantity_total": {
"type": "integer",
"description": ""
},
"unit_price": {
"type": "number",
"description": ""
},
"discount": {
"type": "number",
"description": ""
},
"factor": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"lineprice": {
"type": "number",
"description": ""
},
"supplier_planningmateriaal": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectequipment/0"
}
}
},
"SubrentalEquipmentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"subrental_group",
"equipment",
"parent",
"planperiod_start",
"planperiod_end",
"name",
"quantity",
"quantity_total",
"unit_price",
"discount",
"factor",
"order",
"remark",
"lineprice",
"supplier_planningmateriaal"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"subrental_group": {
"type": "string",
"description": "",
"example": "/subrentalequipmentgroup/0"
},
"equipment": {
"type": [
"string",
"null"
],
"description": "",
"example": "/equipment/0"
},
"parent": {
"type": [
"string",
"null"
],
"description": "",
"example": "/subrentalequipment/0"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"name": {
"type": "string",
"description": ""
},
"quantity": {
"type": "integer",
"description": ""
},
"quantity_total": {
"type": "integer",
"description": ""
},
"unit_price": {
"type": "number",
"description": ""
},
"discount": {
"type": "number",
"description": ""
},
"factor": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"lineprice": {
"type": "number",
"description": ""
},
"supplier_planningmateriaal": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectequipment/0"
}
}
},
"SubrentalEquipmentGroupRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"supplier_category": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectequipmentgroup/0"
}
}
},
"SubrentalEquipmentGroupResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"subrental",
"name",
"order",
"supplier_category"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"subrental": {
"type": "string",
"description": "",
"example": "/subrentals/0"
},
"name": {
"type": "string",
"description": ""
},
"order": {
"type": "string",
"description": ""
},
"supplier_category": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectequipmentgroup/0"
}
}
},
"SubrentalRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"accountmanager": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"reference": {
"type": "string",
"description": ""
},
"supplier": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"number": {
"type": "string",
"description": ""
},
"contactperson": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"location_contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"delivery_in": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"delivery_out": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"equipment_cost": {
"type": "number",
"description": ""
},
"price": {
"type": "number",
"description": ""
},
"extra_cost": {
"type": "number",
"description": "For possible transport costs, administration costs etc."
},
"auto_update_costs": {
"type": "boolean",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"Pick up",
"Delivery at warehouse",
"Delivery at location"
]
},
"status": {
"type": "string",
"description": "",
"example": "/statuses/0"
},
"sent": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"asset_location_to": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"asset_location_from": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"is_internal": {
"type": "boolean",
"description": ""
},
"supplier_project": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projects/0"
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"SubrentalResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"accountmanager",
"reference",
"supplier",
"number",
"contactperson",
"location",
"location_contact",
"usageperiod_start",
"usageperiod_end",
"planperiod_start",
"planperiod_end",
"delivery_in",
"delivery_out",
"equipment_cost",
"price",
"extra_cost",
"auto_update_costs",
"remark",
"type",
"status",
"sent",
"asset_location_to",
"asset_location_from",
"is_internal",
"supplier_project",
"tags",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"accountmanager": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"reference": {
"type": "string",
"description": ""
},
"supplier": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"number": {
"type": "string",
"description": ""
},
"contactperson": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contacts/0"
},
"location_contact": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"usageperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"usageperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"planperiod_end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"delivery_in": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"delivery_out": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"equipment_cost": {
"type": "number",
"description": ""
},
"price": {
"type": "number",
"description": ""
},
"extra_cost": {
"type": "number",
"description": "For possible transport costs, administration costs etc."
},
"auto_update_costs": {
"type": "boolean",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"Pick up",
"Delivery at warehouse",
"Delivery at location"
]
},
"status": {
"type": "string",
"description": "",
"example": "/statuses/0"
},
"sent": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"asset_location_to": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"asset_location_from": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"is_internal": {
"type": "boolean",
"description": ""
},
"supplier_project": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projects/0"
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"SubtaskRequest": {
"type": "object",
"required": [],
"properties": {
"title": {
"type": "string",
"description": ""
},
"completed": {
"type": "boolean",
"description": ""
}
}
},
"SubtaskResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"task",
"title",
"completed"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"task": {
"type": "string",
"description": "",
"example": "/tasks/0"
},
"title": {
"type": "string",
"description": ""
},
"completed": {
"type": "boolean",
"description": ""
}
}
},
"SupplierRequest": {
"type": "object",
"required": [
"contact"
],
"properties": {
"contact": {
"type": "string",
"description": "",
"example": "/contacts/0"
},
"contactperson": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"price": {
"type": "number",
"description": ""
},
"details": {
"type": "string",
"description": ""
}
}
},
"SupplierResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"equipment",
"contact",
"contactperson",
"price",
"details"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"equipment": {
"type": "string",
"description": "",
"example": "/equipment/0"
},
"contact": {
"type": "string",
"description": "",
"example": "/contacts/0"
},
"contactperson": {
"type": [
"string",
"null"
],
"description": "",
"example": "/contactpersons/0"
},
"price": {
"type": "number",
"description": ""
},
"details": {
"type": "string",
"description": ""
}
}
},
"TaskAssignmentRequest": {
"type": "object",
"required": [
"crew"
],
"properties": {
"crew": {
"type": "string",
"description": "",
"example": "/crew/0"
}
}
},
"TaskAssignmentResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"task",
"crew"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"task": {
"type": "string",
"description": "",
"example": "/tasks/0"
},
"crew": {
"type": "string",
"description": "",
"example": "/crew/0"
}
}
},
"TaskRequest": {
"type": "object",
"required": [
"color"
],
"properties": {
"recurhoe": {
"type": "string",
"description": "",
"enum": [
"once",
"days",
"weeks",
"months",
"years",
"specific_days"
]
},
"recureind": {
"type": [
"string",
"null"
],
"description": ""
},
"recurperiode": {
"type": "integer",
"description": ""
},
"is_template": {
"type": "boolean",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"details": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"priority": {
"type": "string",
"description": "",
"enum": [
"no_priority",
"low_priority",
"medium_priority",
"high_priority"
]
},
"order": {
"type": "string",
"description": ""
},
"deadline": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"deadline_type": {
"type": "string",
"description": "",
"enum": [
"specific_date",
"relative_to_project_time"
]
},
"deadline_relative_offset_base": {
"type": "string",
"description": "",
"enum": [
"start_of_period",
"end_of_period"
]
},
"deadline_relative_offset_amount": {
"type": "integer",
"description": ""
},
"deadline_relative_offset_unit": {
"type": "string",
"description": "",
"enum": [
"days",
"hours"
]
},
"deadline_relative_offset_direction": {
"type": "string",
"description": "",
"enum": [
"before",
"after"
]
},
"completed_at": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"status": {
"type": "string",
"description": "",
"example": "/taskstatuses/0"
},
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"itemtype": {
"type": [
"string",
"null"
],
"description": "",
"enum": [
"Contact",
"Container",
"Contract",
"SerialNumber",
"Factuur",
"Subrental",
"InventoryCountJob",
"InspectionReportSerialNumber",
"Supplier",
"Equipment",
"LostEquipment",
"Crew",
"Quotation",
"ContactPerson",
"Project",
"PurchaseOrder",
"Repair",
"Statistic",
"Vehicle"
]
},
"synchronization_id": {
"type": "string",
"description": ""
},
"synchronization_uri": {
"type": "string",
"description": ""
},
"public": {
"type": "string",
"description": "",
"enum": [
0,
1
]
},
"assignment_type": {
"type": "string",
"description": "",
"enum": [
"all_crewmembers",
"selected_crewmembers",
"creator_only"
]
},
"completed_by": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"expiry_notification_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"time_budget": {
"type": [
"number",
"null"
],
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"TaskResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"recurhoe",
"recureind",
"recurperiode",
"is_template",
"name",
"details",
"color",
"priority",
"order",
"deadline",
"deadline_type",
"deadline_relative_offset_base",
"deadline_relative_offset_amount",
"deadline_relative_offset_unit",
"deadline_relative_offset_direction",
"completed_at",
"status",
"item",
"itemtype",
"synchronization_id",
"synchronization_uri",
"public",
"assignment_type",
"completed_by",
"expiry_notification_date",
"time_budget",
"tags",
"parent_api_path",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": "string",
"description": ""
},
"modified": {
"type": "string",
"description": ""
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"recurhoe": {
"type": "string",
"description": "",
"enum": [
"once",
"days",
"weeks",
"months",
"years",
"specific_days"
]
},
"recureind": {
"type": [
"string",
"null"
],
"description": ""
},
"recurperiode": {
"type": "integer",
"description": ""
},
"is_template": {
"type": "boolean",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"details": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"priority": {
"type": "string",
"description": "",
"enum": [
"no_priority",
"low_priority",
"medium_priority",
"high_priority"
]
},
"order": {
"type": "string",
"description": ""
},
"deadline": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"deadline_type": {
"type": "string",
"description": "",
"enum": [
"specific_date",
"relative_to_project_time"
]
},
"deadline_relative_offset_base": {
"type": "string",
"description": "",
"enum": [
"start_of_period",
"end_of_period"
]
},
"deadline_relative_offset_amount": {
"type": "integer",
"description": ""
},
"deadline_relative_offset_unit": {
"type": "string",
"description": "",
"enum": [
"days",
"hours"
]
},
"deadline_relative_offset_direction": {
"type": "string",
"description": "",
"enum": [
"before",
"after"
]
},
"completed_at": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"status": {
"type": "string",
"description": "",
"example": "/taskstatuses/0"
},
"item": {
"type": [
"integer",
"null"
],
"description": "Numeric ID of the linked item (plain integer, not a path).",
"example": 0
},
"itemtype": {
"type": [
"string",
"null"
],
"description": "",
"enum": [
"Contact",
"Container",
"Contract",
"SerialNumber",
"Factuur",
"Subrental",
"InventoryCountJob",
"InspectionReportSerialNumber",
"Supplier",
"Equipment",
"LostEquipment",
"Crew",
"Quotation",
"ContactPerson",
"Project",
"PurchaseOrder",
"Repair",
"Statistic",
"Vehicle"
]
},
"synchronization_id": {
"type": "string",
"description": ""
},
"synchronization_uri": {
"type": "string",
"description": ""
},
"public": {
"type": "string",
"description": "",
"enum": [
0,
1
]
},
"assignment_type": {
"type": "string",
"description": "",
"enum": [
"all_crewmembers",
"selected_crewmembers",
"creator_only"
]
},
"completed_by": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"expiry_notification_date": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"time_budget": {
"type": [
"number",
"null"
],
"description": ""
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"parent_api_path": {
"type": "string",
"description": "GENERATED FIELD. ~~The API path of the parent item. Use this path to fetch the parent item directly from the API.~~."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"TaskStatusRequest": {
"type": "object",
"required": [
"color"
],
"properties": {
"name": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"todo",
"done",
"custom"
]
},
"order": {
"type": "string",
"description": ""
}
}
},
"TaskStatusResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"color",
"type",
"order"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"todo",
"done",
"custom"
]
},
"order": {
"type": "string",
"description": ""
}
}
},
"TaxClassRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
},
"code": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"vat",
"tax",
"notax"
]
}
}
},
"TaxClassResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name",
"code",
"type"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
},
"code": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"vat",
"tax",
"notax"
]
}
}
},
"TimeRegistrationRequest": {
"type": "object",
"required": [],
"properties": {
"crewmember": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"distance": {
"type": "number",
"description": ""
},
"is_lunch_included": {
"type": "boolean",
"description": ""
},
"leavetype": {
"type": [
"string",
"null"
],
"description": "",
"example": "/leavetypes/0"
},
"duration": {
"type": "number",
"description": "For time registration of worked hours, the duration will be calculated automatically based on the start and end time. For leave registrations that affect an hour balance, the duration can differ from the start and end time and should contain the number of hours that have to be deducted from the hour balance of the crew member."
},
"break_duration": {
"type": [
"number",
"null"
],
"description": ""
},
"travel_time": {
"type": [
"number",
"null"
],
"description": ""
},
"correction_duration": {
"type": [
"number",
"null"
],
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"TimeRegistrationResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"crewmember",
"start",
"end",
"distance",
"is_lunch_included",
"leavetype",
"leaverequest",
"duration",
"break_duration",
"travel_time",
"correction_duration",
"remark",
"status",
"break_duration_with_start_end",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"crewmember": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"start": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"end": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"distance": {
"type": "number",
"description": ""
},
"is_lunch_included": {
"type": "boolean",
"description": ""
},
"leavetype": {
"type": [
"string",
"null"
],
"description": "",
"example": "/leavetypes/0"
},
"leaverequest": {
"type": [
"string",
"null"
],
"description": "",
"example": "/leaverequest/0"
},
"duration": {
"type": "number",
"description": "For time registration of worked hours, the duration will be calculated automatically based on the start and end time. For leave registrations that affect an hour balance, the duration can differ from the start and end time and should contain the number of hours that have to be deducted from the hour balance of the crew member."
},
"break_duration": {
"type": [
"number",
"null"
],
"description": ""
},
"travel_time": {
"type": [
"number",
"null"
],
"description": ""
},
"correction_duration": {
"type": [
"number",
"null"
],
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"status": {
"type": "string",
"description": "",
"enum": [
"pending",
"approved",
"rejected"
]
},
"break_duration_with_start_end": {
"type": [
"number",
"null"
],
"description": "GENERATED FIELD. The sum of breaks that were created for this time registration with exact start and end time."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"TimeRegistrationActivityRequest": {
"type": "object",
"required": [],
"properties": {
"project_function": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectfunctions/0"
},
"subproject_function": {
"type": [
"string",
"null"
],
"description": "",
"example": "/subprojects/0"
},
"description": {
"type": "string",
"description": ""
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"is_activity": {
"type": "boolean",
"description": ""
},
"from": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
}
}
},
"TimeRegistrationActivityResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"time_registration",
"project_function",
"subproject_function",
"description",
"duration",
"is_activity",
"from",
"to"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"time_registration": {
"type": "string",
"description": "",
"example": "/timeregistration/0"
},
"project_function": {
"type": [
"string",
"null"
],
"description": "",
"example": "/projectfunctions/0"
},
"subproject_function": {
"type": [
"string",
"null"
],
"description": "",
"example": "/subprojects/0"
},
"description": {
"type": "string",
"description": ""
},
"duration": {
"type": [
"number",
"null"
],
"description": ""
},
"is_activity": {
"type": "boolean",
"description": ""
},
"from": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"to": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
}
}
},
"VehicleRequest": {
"type": "object",
"required": [],
"properties": {
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"name": {
"type": "string",
"description": ""
},
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
},
"in_planner": {
"type": "boolean",
"description": ""
},
"height": {
"type": "number",
"description": ""
},
"length": {
"type": "number",
"description": ""
},
"width": {
"type": "number",
"description": ""
},
"seats": {
"type": "integer",
"description": ""
},
"inspection_date": {
"type": [
"string",
"null"
],
"description": ""
},
"licenseplate": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"payload_capacity": {
"type": "number",
"description": ""
},
"surface_area": {
"type": "string",
"description": ""
},
"multiple": {
"type": "string",
"description": "Can be scheduled more than once at the same time. For example, for employment agencies.",
"enum": [
"plannable_once",
"plannable_multi"
]
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"asset_location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"VehicleResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"folder",
"name",
"cost_rate",
"in_planner",
"height",
"length",
"width",
"seats",
"inspection_date",
"licenseplate",
"remark",
"payload_capacity",
"surface_area",
"multiple",
"image",
"asset_location",
"tags",
"distance_cost",
"fixed_cost",
"custom"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"folder": {
"type": [
"string",
"null"
],
"description": "",
"example": "/folders/0"
},
"name": {
"type": "string",
"description": ""
},
"cost_rate": {
"type": [
"string",
"null"
],
"description": "",
"example": "/rates/0"
},
"in_planner": {
"type": "boolean",
"description": ""
},
"height": {
"type": "number",
"description": ""
},
"length": {
"type": "number",
"description": ""
},
"width": {
"type": "number",
"description": ""
},
"seats": {
"type": "integer",
"description": ""
},
"inspection_date": {
"type": [
"string",
"null"
],
"description": ""
},
"licenseplate": {
"type": "string",
"description": ""
},
"remark": {
"type": "string",
"description": ""
},
"payload_capacity": {
"type": "number",
"description": ""
},
"surface_area": {
"type": "string",
"description": ""
},
"multiple": {
"type": "string",
"description": "Can be scheduled more than once at the same time. For example, for employment agencies.",
"enum": [
"plannable_once",
"plannable_multi"
]
},
"image": {
"type": [
"string",
"null"
],
"description": "",
"example": "/files/0"
},
"asset_location": {
"type": [
"string",
"null"
],
"description": "",
"example": "/stocklocations/0"
},
"tags": {
"type": "string",
"description": "GENERATED FIELD. Tags starting with 'import-' are hidden in this field."
},
"distance_cost": {
"type": "number",
"description": "GENERATED FIELD. Costs per kilometer."
},
"fixed_cost": {
"type": "number",
"description": "GENERATED FIELD."
},
"custom": {
"type": "object",
"description": "The object containing all custom defined fields.",
"example": {
"custom_1": "string",
"custom_2": 2
}
}
}
},
"WarehouseStatusRequest": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"description": ""
}
}
},
"WarehouseStatusResponse": {
"type": "object",
"required": [
"id",
"created",
"modified",
"creator",
"displayname",
"name"
],
"properties": {
"id": {
"type": "integer",
"description": ""
},
"created": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"modified": {
"type": [
"string",
"null"
],
"description": "",
"format": "date-time"
},
"creator": {
"type": [
"string",
"null"
],
"description": "",
"example": "/crew/0"
},
"displayname": {
"type": "string",
"description": "GENERATED FIELD."
},
"name": {
"type": "string",
"description": ""
}
}
}
}
}
}