/api/documents

post

https://api.facilioo.de/api/documents

Create Document

Creates a new document from the provided data, associating it within the requester's scope.

Module: Documents

Returns: Documents → Documents → DocumentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

Body Params

title

string

required

length between 1 and 255

Title of the document.

description

string | null

Optional description providing additional information about the document.

groupId

int32 | null

Identifier of the document group used for categorization. Documents can also be placed at root-level, when leaving this field null.

date

date-time | null

Business-related date of the document (e.g. issue date or effective date).

propertyId

int32 | null

Identifier of the property this document is assigned to. At least one of PropertyId, UnitId, ContractId or PartyId must be provided.

unitId

int32 | null

Identifier of the unit this document is assigned to. At least one of PropertyId, UnitId, ContractId or PartyId must be provided.

contractId

int32 | null

Identifier of the contract this document is assigned to. At least one of PropertyId, UnitId, ContractId or PartyId must be provided.

partyId

int32 | null

Identifier of the party this document is assigned to. This doesn't imply immediate access to the document for this party. At least one of PropertyId, UnitId, ContractId or PartyId must be provided.

fileId

int32

required

Identifier of the file entity containing the document content.

externalId

string | null

Optional identifier linking the document to an external system.

Headers

Accept-Language

string

Language preference header. Allowed languages: German (en-DE).

api-version

string

Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

Responses

401

Error: Unauthorized

200OK

400Bad Request

404Not Found