Documents

patch

https://app.financekey.com/OData/Documents({key})

The BusinessPartnerDocument table stores documents related to each individual business partner. This includes legal documents, contracts, certificates and other records associated with the partner. The table stores the name of the document, its type, the ID of the associated business partner, and the date the document was added. Additionally, it stores a BLOB field to store a copy of the document, if it is digitalized.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

name

string

required

length ≥ 1

The document purpose or name.

entityKeyValue

string | null

EntityKeyValue is a field in the Document table of data type nvarchar used to store a unique identifier associated with the document. The identifier is constructed from the values of other fields in the document table. This allows the document to be easily located in the database.

entityId

string | null

EntityId is a nvarchar field with a maximum length of 450 in the Document table. It is used to store unique identifiers that identify an object within the system, allowing it to be referenced and retrieved by calling its EntityId.

documentTypeId

string

required

length between 1 and 450

The type of document that is being loaded.

reference

string | null

The Reference field in the Document table is a nvarchar data type used to store a unique identifier or code assigned to a specific document. This field serves as a reference point for locating or identifying the document within a larger database or system. It can contain a combination of letters, numbers, and other characters to create a unique reference. This field is often used as a key attribute for sorting, organizing, and retrieving documents within a document management system. It provides an efficient means of quickly accessing and referencing important documents.

effectiveDate

date-time | null

The EffectiveDate field represents the date and time when the document becomes effective and is applicable. It is of type datetime2, allowing for a high degree of precision in capturing both the date and time. This field is essential for tracking the validity period of the document and can be used to determine the chronological relevance of the content contained within.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!