# Pland Developer Platform

## Docs

- [Create Absence](https://docs.pland.app/api-reference/absences/create.md): Create a new absence record for a user. Requires dtStart and dtEnd dates. If no userId is provided, creates absence for the authenticated user.
- [Get Absence](https://docs.pland.app/api-reference/absences/get.md): Get a specific absence by its ID.
- [List Absences](https://docs.pland.app/api-reference/absences/list.md): List all absences in the system with optional filtering, pagination, and sorting capabilities. Supports filtering by status, dates, users, pay types, and more.
- [List Personal Absences](https://docs.pland.app/api-reference/absences/list-self.md): List all absences for the current authenticated user. Returns absences with filtering, pagination, and sorting support.
- [Update Absence](https://docs.pland.app/api-reference/absences/update.md): Update an existing absence record with new data. Only provided fields will be updated.
- [Create Article](https://docs.pland.app/api-reference/articles/create.md): Create a new article with supplier and group ID conversion.
- [Get Article](https://docs.pland.app/api-reference/articles/get.md): Retrieve an article by its unique identifier.
- [Get Last Number](https://docs.pland.app/api-reference/articles/get-last-number.md): Get the last used number for articles.
- [List Articles](https://docs.pland.app/api-reference/articles/list.md): Get a list of all articles. Supports filtering, pagination, and sorting.
- [Update Article](https://docs.pland.app/api-reference/articles/update.md): Update an existing article. Only provided fields will be updated.
- [Create Ticket](https://docs.pland.app/api-reference/complaints/create.md): Create a new complaint.
- [Get Tickets](https://docs.pland.app/api-reference/complaints/get.md): Retrieve detailed information about a specific complaint by its unique identifier. Returns comprehensive complaint data including images, contact information, and resolution details.
- [List Tickets](https://docs.pland.app/api-reference/complaints/list.md): List all complaints with optional filtering, pagination, and sorting. Returns comprehensive complaint data including customer object information and status details.
- [Update Ticket](https://docs.pland.app/api-reference/complaints/update.md): Update an existing complaint with new information, status changes, or additional details.
- [Batch Update Customers](https://docs.pland.app/api-reference/customers/batch-update.md): Update multiple customers at once. Useful for bulk operations like status changes.
- [Create Customer](https://docs.pland.app/api-reference/customers/create.md): Create a new customer with automatic number assignment if not provided
- [Get Customer](https://docs.pland.app/api-reference/customers/get.md): Get a specific customer by ID with complete details including address, contact information, and contract details.
- [Get Last Object Number](https://docs.pland.app/api-reference/customers/get-last-number.md): Get the highest customer number currently in use. Used for generating the next customer number.
- [List Customers](https://docs.pland.app/api-reference/customers/list.md): List all customers with optional filtering, pagination, and sorting. Supports filtering by name, address, customer numbers, and object manager assignments.
- [Update Customer](https://docs.pland.app/api-reference/customers/update.md): Update an existing customer. All fields are optional and only provided fields will be updated.
- [Upload Documents](https://docs.pland.app/api-reference/documents/create.md): Upload one or more documents as files (multipart/form-data). The document can be associated with an object, user, job, or customer by providing the respective IDs. At least one Id must be provided.
- [Create Document from URL](https://docs.pland.app/api-reference/documents/create-from-url.md): Create a document by providing an external URL. The file will be fetched and stored.
- [Delete Document](https://docs.pland.app/api-reference/documents/delete.md): Delete a document by its ID.
- [Get Document](https://docs.pland.app/api-reference/documents/get.md): Retrieve a document by its unique identifier.
- [List Documents](https://docs.pland.app/api-reference/documents/list.md): List documents by their IDs. Requires a filter with document IDs.
- [List Documents for Entity](https://docs.pland.app/api-reference/documents/list-by-entity.md): Retrieve all documents attached to a specific entity.
- [Update Document](https://docs.pland.app/api-reference/documents/update.md): Update a document's metadata or properties.
- [Batch Update Equipment](https://docs.pland.app/api-reference/equipment/batch-update.md): Update multiple equipment items at once
- [Create Equipment](https://docs.pland.app/api-reference/equipment/create.md): Create a new equipment item
- [Get Equipment](https://docs.pland.app/api-reference/equipment/get.md): Get a specific equipment item by ID
- [List Equipment](https://docs.pland.app/api-reference/equipment/list.md): List all equipment with optional filtering, pagination, and sorting
- [Update Equipment](https://docs.pland.app/api-reference/equipment/update.md): Update an existing equipment item
- [Authentication](https://docs.pland.app/api-reference/getting-started/authentication.md): Learn how to authenticate your requests to the PlanD API using Bearer tokens or API keys
- [Pagination](https://docs.pland.app/api-reference/getting-started/pagination.md): Learn how to paginate through large datasets using offset-based pagination in the PlanD API
- [Sorting](https://docs.pland.app/api-reference/getting-started/sorting.md): The PlanD API supports sorting on list endpoints using the `sort` parameter. You can sort by multiple fields and specify sort direction.
- [List Jobs in Timeframe](https://docs.pland.app/api-reference/jobs/list-in-timeframe.md): Retrieve jobs within a specified time frame with optional filters.
- [List Open Jobs](https://docs.pland.app/api-reference/jobs/list-open.md): Get all jobs that are not assigned to a user within a given time frame.
- [Send Message](https://docs.pland.app/api-reference/logbuch/send-message.md): Send a new chat message to a chat.
- [Send Note](https://docs.pland.app/api-reference/logbuch/send-note.md): Send a new note message to a chat.
- [Create Material Order](https://docs.pland.app/api-reference/material-orders/create.md): Create a material order for a specific object. Requires a list of items and optional comment.
- [Get Material Order](https://docs.pland.app/api-reference/material-orders/get.md): Retrieve a material order by its unique identifier.
- [List Material Orders](https://docs.pland.app/api-reference/material-orders/list.md): Get a list of all material orders. Supports filtering, pagination, and sorting.
- [Update Material Order](https://docs.pland.app/api-reference/material-orders/update.md): Update an existing order. Only provided fields will be updated.
- [Create Object](https://docs.pland.app/api-reference/objects/create.md): Create a new customer object. If no customer ID is provided, a new customer will be created automatically.
- [Get Object](https://docs.pland.app/api-reference/objects/get.md): Retrieve detailed information about a specific customer object by its unique identifier.
- [Get Object by Number](https://docs.pland.app/api-reference/objects/get-by-number.md): Retrieve a customer object using its number instead of its MongoDB ID.
- [Get Last Number](https://docs.pland.app/api-reference/objects/get-last-number.md): Get the highest object number currently in use, useful for generating the next sequential number.
- [List Objects](https://docs.pland.app/api-reference/objects/list.md): List all customer objects with optional filtering, pagination, and sorting. Customer objects represent locations or buildings where services are performed.
- [Update Object](https://docs.pland.app/api-reference/objects/update.md): Update an existing customer object with new information. Only provided fields will be updated.
- [Create Quality Control](https://docs.pland.app/api-reference/quality-control/create.md): Create a new quality control entry. This automatically updates object and room ratings based on the assessment and sends notifications to relevant users.
- [Get Quality Control](https://docs.pland.app/api-reference/quality-control/get.md): Get detailed information about a specific quality control entry including room checks, service evaluations, and images.
- [List Quality Controls](https://docs.pland.app/api-reference/quality-control/list.md): List all quality control entries with optional filtering, pagination, and sorting. Quality control entries track assessments of object cleanliness and service quality.
- [List Quality Control by Object](https://docs.pland.app/api-reference/quality-control/list-by-object.md): List all quality control entries for a specific object. This endpoint returns all quality assessments performed on the specified object.
- [List Quality Control by Object Manager](https://docs.pland.app/api-reference/quality-control/list-by-object-manager.md): List all quality control entries for a specific object manager. This endpoint returns quality assessments created by the specified object manager.
- [Export Salary Rows](https://docs.pland.app/api-reference/salaries/export-rows.md): Export salary rows data immediately and return as ZIP file. This is the main export method for user salaries using salary rows.
- [List Salaries](https://docs.pland.app/api-reference/salaries/list.md): List salary records with optional filtering, pagination, and sorting. Supports various filters for advanced querying of salary data.
- [Create Task Type](https://docs.pland.app/api-reference/task-types/create.md): Create a new task type
- [Delete Task Type](https://docs.pland.app/api-reference/task-types/delete.md): Delete a task type
- [Get Task Type](https://docs.pland.app/api-reference/task-types/get.md): Get a task type
- [List Task Types](https://docs.pland.app/api-reference/task-types/list.md): List all task types
- [Update Task Type](https://docs.pland.app/api-reference/task-types/update.md): Update a task type
- [Complete Task](https://docs.pland.app/api-reference/tasks/complete.md): Mark a task as completed with optional email notification. Optionally sends a completion email to a specified recipient.
- [Create Task](https://docs.pland.app/api-reference/tasks/create.md): Create a new task
- [Delete Tasks](https://docs.pland.app/api-reference/tasks/delete.md): Delete multiple tasks
- [Get Task](https://docs.pland.app/api-reference/tasks/get.md): Get a task
- [List Tasks](https://docs.pland.app/api-reference/tasks/list.md): List all tasks with optional filtering, pagination, and sorting. Supports comprehensive filtering options including task type, assignment, activity type, and more.
- [Update Task](https://docs.pland.app/api-reference/tasks/update.md)
- [List Time Trackings](https://docs.pland.app/api-reference/time-tracking/list.md): Filter and retrieve time tracking entries based on various criteria including user, date range, object, and activity type. Supports pagination and sorting.
- [Create User](https://docs.pland.app/api-reference/users/create.md): Creates a new user in the system with the provided information
- [Delete User](https://docs.pland.app/api-reference/users/delete.md): Safely delete a user from the system. This operation sets the user status to inactive rather than permanently removing the record, preserving data integrity and historical references.
- [Get User](https://docs.pland.app/api-reference/users/get.md): Retrieves a user by their ID. Use "self" as ID to get the authenticated user's own information.
- [Get User by Number](https://docs.pland.app/api-reference/users/get-by-number.md): Retrieves a user by their employee number
- [Get Last Number](https://docs.pland.app/api-reference/users/get-last-number.md): Get the highest user number currently in use in the system. This is typically used for generating the next sequential user number.
- [List Users](https://docs.pland.app/api-reference/users/list.md): List all users in the system with optional filtering, pagination, and sorting capabilities. Supports advanced filtering by name, employment, status, tags, time availability, and more.
- [Send Invite SMS to User](https://docs.pland.app/api-reference/users/send-invite-sms.md): Generates a new password for the specified user and sends it via SMS
- [Update User](https://docs.pland.app/api-reference/users/update.md): Update a specific user by ID. Supports partial updates and can modify any user property including personal information, employment details, and system settings.
- [Create Webhook](https://docs.pland.app/api-reference/webhooks/create.md): Create a new webhook. The webhook will be triggered on the specified entity and type.
- [Delete Webhook](https://docs.pland.app/api-reference/webhooks/delete.md): Delete a webhook.
- [List Webhooks](https://docs.pland.app/api-reference/webhooks/list.md): List all webhooks with optional filtering, pagination, and sorting.
- [Update Webhook](https://docs.pland.app/api-reference/webhooks/update.md): Update an existing Webhook
- [Welcome](https://docs.pland.app/index.md): Start building with the Pland Developer Platform

## OpenAPI Specs

- [openapi](https://docs.pland.app/openapi.yaml)
- [openapi ](https://docs.pland.app/openapi .yaml)

## Optional

- [Roadmap](https://feedback.pland.app/de/roadmap/main)
- [Changelog](https://feedback.pland.app/de/changelog)
- [Knowledge Base](https://help.pland.app)