Digitoo API rev. 2.0.0
string · uuid · requiredDocumentIncludeFieldsEnum[]ExcludeFieldsEnum[]AnnotationsFormattingEnum · enumstring
string · uuid · requiredExcludeFieldsEnum[]string
string · uuid · requiredstring
string · uuid · requiredAttachmentOrigin · enumstring
string · uuid · requiredstring
string · uuid · requiredstring
string · uuid · requiredstring · requirednumber · min: 0
string · uuid · requiredstring
string · uuid · requiredFileExportTypeEnum · enum · requiredExportColumnEnum · enumExportFileNameSourceEnum[]StringBoolean · enumstring
string · uuid · requiredstring
string · uuid · requiredstring
string · uuid · requiredstring · enum · required
string · uuid · requiredboolean · requiredstring | null · date-time
string · uuid · requiredstring · enum · requiredstring | nullstring | nullstring | null
string · uuid · requiredstring · requiredstring · enum · requirednumber · min: 0 · requirednumber · min: 0
string · uuid · requiredstring · enum · requirednumber · min: 0 · required
string · uuid · requiredstring · enum · requirednumber · min: 0 · required
Documents
Get document metadata
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
includeComma separated list of additional data which can be returned for each document.
Enum values:
queue-metadata
workspace-metadata
locked-by
lock-status
approval-data
document-url
document-duplicities
workspace-subject-mismatch
excludeComma separated list of additional data which can be excluded for each document.
Enum values:
tax-details
line-items
formattingEnum values:
regular
simplified
Headers
share-keyShare key for accessing resource
Get document metadata › Responses
Get document annotations
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/annotations
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
excludeComma separated list of additional data which can be excluded for each document.
Enum values:
tax-details
line-items
Headers
share-keyShare key for accessing resource
Get document annotations › Responses
object · required
An 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 confidence
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/annotations-confidence
Get document annotation values
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/annotations-values
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Headers
share-keyShare key for accessing resource
Get document annotation values › Responses
object · required
A 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 attachments
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/attachments
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
originEnum values:
original_document
attachment
Headers
share-keyShare key for accessing resource
Get document attachments › Responses
AttachmentDto[] · required
Get document audit log
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/audit-log
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
PaginationQuery · style: deepObject · explode: true
Headers
share-keyShare key for accessing resource
Get document audit log › Responses
DocumentAuditLogDto[] · required
array of response data
object · required
pagination
Get document audit log with UI ready humanized messages
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/audit-log/humanized
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
PaginationQuery · style: deepObject · explode: true
Headers
share-keyShare key for accessing resource
Get document audit log with UI ready humanized messages › Responses
DocumentAuditLogHumanizedItemDto[] · required
array of response data
object · required
pagination
DocumentAuditLogHumanizedDocumentDto · required
Update single basic annotation
POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/basic-annotation
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Update single basic annotation › Request Body
fieldAnnotation field to be updated
object · required
Annotation value object to be set
indexZero based index of the annotation value of a field. Mostly used for multivalue fields.
Update single basic annotation › Responses
Get document email
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/email
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Headers
share-keyShare key for accessing resource
Get document email › Responses
EmailDto · required
Exports document to a specified format
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/export
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
query Parameters
typeFile export type
File export type
Enum values:
csv
pdf
pdf_with_isdoc
png
isdoc
xml
xlsx
export_columns_optionsEnum values:
visible
all
export_file_name_optionsEnum values:
sender_name
sender_register_id
invoice_id
internal_erp_id
original_filename
export_line_itemsEnum values:
true
false
Headers
share-keyShare key for accessing resource
Exports document to a specified format › Responses
string
Get initial annotations of document
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/initial-annotations
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Headers
share-keyShare key for accessing resource
Get initial annotations of document › Responses
object · required
An 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
GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/initial-annotations-values
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Headers
share-keyShare key for accessing resource
Get initial annotation values of document › Responses
object · required
A 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 internal ERP ID
PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/internal-erp-id
Sets payment status of the document
PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/payment-status
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Sets payment status of the document › Request Body
statusDocument payment status
Enum values:
paid
paid_partially
unpaid
to_pay
payment_order
past_due
Sets payment status of the document › Responses
No data returned
Enable or disable share status of document
PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/share-status
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Enable or disable share status of document › Request Body
share_enabledTrue for enable, false for disable
expires_atEnable or disable share status of document › Responses
Change document status
PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/status
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Change document status › Request Body
statusNew document status
Enum values:
received
enqueued-for-extraction
extraction-errored
extraction-rejected
waiting-for-human-validation
waiting-for-human-approval
deleted
postponed
internal_erp_idReturned internal document id from ERP. Applied only if new status is exported
export_errorError message from ERP. Applied only if new status is export-errored
export_error_descriptionError description from ERP. Applied only if new status is export-errored
Change document status › Responses
No data returned
Update single table annotation
POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-annotation
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Update single table annotation › Request Body
fieldAnnotation field to be updated
table_keyAnnotation table to be updated
Enum values:
line_items
tax_detail
row_indexAnnotation table row index (0-based) to be updated
object · required
Annotation value object to be set
indexZero based index of the annotation value of a field. Mostly used for multivalue fields.
Update single table annotation › Responses
Append new annotation table row
POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/append-row
Duplicate annotation table row
POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/duplicate
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Duplicate annotation table row › Request Body
table_keyEnum values:
line_items
tax_detail
Example: line_items
indexAnnotation table row index (0-based) to be duplicated
Duplicate annotation table row › Responses
Removes all annotation table rows
POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/remove-all
Removes annotation table row
POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/remove-row
path Parameters
document_idAn uuid identifier
Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07
Removes annotation table row › Request Body
table_keyEnum values:
line_items
tax_detail
Example: line_items
indexAnnotation table row index (0-based) to be removed