Get document metadata
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
includestring[]Comma separated list of additional data which can be returned for each document.
Enum values:queue-metadataworkspace-metadatalocked-bylock-statusapproval-datadocument-urldocument-duplicitiesworkspace-subject-mismatchexcludestring[]Comma separated list of additional data which can be excluded for each document.
Enum values:tax-detailsline-itemsformattingstring · enumEnum values:regularsimplified
Headers
share-keystringShare key for accessing resource
Responses
dataobject · required
Get document annotations
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
excludestring[]Comma separated list of additional data which can be excluded for each document.
Enum values:tax-detailsline-items
Headers
share-keystringShare key for accessing resource
Responses
dataobject · requiredAn object of annotations
Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}],"due_date":[{"value":"01.01.2021","iso_date_value":"2021-01-01"}],"bank_account":[{"value":"123"},{"value":"456"}],"line_items":[{"activity":[{"value":"item1"}],"total_incl_tax":[{"value":"123","numeric_value":123}]},{"activity":[{"value":"item2"}],"total_incl_tax":[{"value":"456","numeric_value":456}]}]}
Get document annotation values
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Headers
share-keystringShare key for accessing resource
Responses
dataobject · requiredA list of annotations values
Example: {"invoice_id":"123","total_due":123,"due_date":"2021-01-01","bank_account":["123","456"],"line_items":[{"activity":"item1","total_incl_tax":123},{"activity":"item2","total_incl_tax":456}]}
Get document audit log
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
pageobject · style: deepObject · explode: true
Headers
share-keystringShare key for accessing resource
Responses
dataobject[] · requiredarray of response data
paginationrequiredpagination
Get document audit log with UI ready humanized messages
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
pageobject · style: deepObject · explode: true
Headers
share-keystringShare key for accessing resource
Responses
dataobject[] · requiredarray of response data
paginationrequiredpagination
documentobject · required
Update single basic annotation
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Request Body
fieldstring · requiredAnnotation field to be updated
valuerequiredAnnotation value object to be set
indexnumber · min: 0Zero based index of the annotation value of a field. Mostly used for multivalue fields.
Responses
dataobject · required
Exports document to a specified format
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
typestring · enum · requiredFile export type
File export type
Enum values:csvpdfpdf_with_isdocpngisdocxmlxlsxexport_columns_optionsstring · enumEnum values:visibleallexport_file_name_optionsstring[]Enum values:sender_namesender_register_idinvoice_idinternal_erp_idoriginal_filenameexport_line_itemsstring · enumEnum values:truefalse
Headers
share-keystringShare key for accessing resource
Responses
Get initial annotations of document
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Headers
share-keystringShare key for accessing resource
Responses
dataobject · requiredAn object of annotations
Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}],"due_date":[{"value":"01.01.2021","iso_date_value":"2021-01-01"}],"bank_account":[{"value":"123"},{"value":"456"}],"line_items":[{"activity":[{"value":"item1"}],"total_incl_tax":[{"value":"123","numeric_value":123}]},{"activity":[{"value":"item2"}],"total_incl_tax":[{"value":"456","numeric_value":456}]}]}
Get initial annotation values of document
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Headers
share-keystringShare key for accessing resource
Responses
dataobject · requiredA list of annotations values
Example: {"invoice_id":"123","total_due":123,"due_date":"2021-01-01","bank_account":["123","456"],"line_items":[{"activity":"item1","total_incl_tax":123},{"activity":"item2","total_incl_tax":456}]}
Change document status
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Request Body
statusrequiredNew document status
internal_erp_idstring | nullReturned internal document id from ERP. Applied only if new status is exported
export_errorstring | nullError message from ERP. Applied only if new status is export-errored
export_error_descriptionstring | nullError description from ERP. Applied only if new status is export-errored
Responses
Update single table annotation
path Parameters
document_idstring · uuid · requiredAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Request Body
fieldstring · requiredAnnotation field to be updated
table_keyrequiredAnnotation table to be updated
row_indexnumber · min: 0 · requiredAnnotation table row index (0-based) to be updated
valuerequiredAnnotation value object to be set
indexnumber · min: 0Zero based index of the annotation value of a field. Mostly used for multivalue fields.
Responses
dataobject · required