Typeless documents are documents of which the type is not yet known. For example, a document uploaded via email or via the bulk uploader. It is not possible to update a typeless document, except for adding attachments. You will need to set its type first. You cannot set the type of typeless documents using the API yet, but you can do this via the website.
List ids and versions of typeless documents
Returns all documents in the administration. The list contains the document id and the version of the document.
Check if the version of the document is newer than the version you have stored locally, use the POST
variant for fetching documents with the given ids.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstringString terms, example: key1:value1,key2:value2.
Responses
IDs and versions of records
idinteger | stringversioninteger | string
Fetch typeless documents with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A list of typeless documents
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactreferencestring | nulldatestring · datestatestring · enumEnum values:newopenlatepaidsavedpending_paymentoriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvcreated_atstring · date-timeupdated_atstring · date-timeversionintegerattachmentsobject[]eventsobject[]
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL
where the attachment can be downloaded. Use the Location header in the response
to download the attachment.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
attachment_idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Found
Delete an attachment
Deletes an attachment of an attachable.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
attachment_idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Attachment deleted
Add attachment to typeless document
Add an attachment to a typeless document.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Status code
Get a typeless document
Returns a typeless document by id.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A typeless document
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactreferencestring | nulldatestring · datestatestring · enumEnum values:newopenlatepaidsavedpending_paymentoriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvcreated_atstring · date-timeupdated_atstring · date-timeversionintegerattachmentsobject[]eventsobject[]
Delete a typeless document
Deletes a typeless document.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Status code
Get typeless documents
Returns a paginated list of documents of this type in the administration.
The filter argument allows you to filter on the list of documents. Filters are a combination of keys and values,
separated by a comma: key:value,key2:value2. The most common filter method will be period: period:this_month.
Filtering works the same as in the web application, for more advanced examples, change the filtering in the web
application and learn from the resulting URI.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstringString terms, example:
key1:value1,key2:value2.new_filterstringString terms, example:
key1:value1,key2:value2.pageinteger | stringper_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$exclude_new_general_journal_documentsboolean | string
Responses
A list of typeless documents
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactreferencestring | nulldatestring · datestatestring · enumEnum values:newopenlatepaidsavedpending_paymentoriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvcreated_atstring · date-timeupdated_atstring · date-timeversionintegerattachmentsobject[]eventsobject[]
Create a new typeless document
Creates a new typeless document.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Typeless document created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactreferencestring | nulldatestring · datestatestring · enumEnum values:newopenlatepaidsavedpending_paymentoriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvcreated_atstring · date-timeupdated_atstring · date-timeversionintegerattachmentsobject[]eventsobject[]