General journal documents are used for manual bookkeeping entries, to correct errors or make adjustments.
List ids and versions of general journal 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_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterString terms, example: key1:value1,key2:value2.
List ids and versions of general journal documents › Responses
IDs and versions of records
idversionFetch general journal 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_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Fetch general journal documents with given ids › Responses
A list of general journal documents
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
referencedatejournal_typecreated_atupdated_atversionDestroys note from entity
Deletes a note from the general journal document.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
general_journal_document_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Destroys note from entity › Responses
Note deleted
Adds note to entity
Adds a note to the general journal document.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
general_journal_document_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Adds note to entity › Responses
Note created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
entity_id^\d+$A unique record identifier
entity_typeuser_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
todonotecompleted_atcompleted_by_id^\d+$A unique record identifier
todo_typedatacreated_atupdated_atDownload 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_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
attachment_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Download attachment › Responses
Found
Delete an attachment
Deletes an attachment of an attachable.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
attachment_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete an attachment › Responses
Attachment deleted
Add attachment to general journal document
Add an attachment to a general journal document.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Add attachment to general journal document › Responses
Status code
Get general journal document
Returns a general journal document by id.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Get general journal document › Responses
A general journal document
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
referencedatejournal_typecreated_atupdated_atversionDelete a general journal document
Deletes a general journal document.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete a general journal document › Responses
Status code
Update a general journal document
Updates a general journal document.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Update a general journal document › Responses
General journal document updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
referencedatejournal_typecreated_atupdated_atversionGet general journal 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_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterString terms, example: key1:value1,key2:value2.
new_filterString terms, example: key1:value1,key2:value2.
pageper_page^\d+$exclude_new_general_journal_documentsGet general journal documents › Responses
A list of general journal documents
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
referencedatejournal_typecreated_atupdated_atversionCreate a new general journal document
Creates a new general journal document.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Create a new general journal document › Responses
General journal document created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
referencedatejournal_typecreated_atupdated_atversion