Schemas
AboPaymentDialogAlphanumericDataType
value
string | null · requirederrors
string[] · requiredEnum values:missing_fieldmissing_valueinvalid_bank_accountunable_to_pay_negative_amountunable_to_pay_zero_amountalready_paidinvalid_currencyvalidation_errors
object[] · required
AboPaymentDialogNumericDataType
value
string | null · requirednumeric_value
number | null · requirederrors
string[] · requiredEnum values:missing_fieldmissing_valueinvalid_bank_accountunable_to_pay_negative_amountunable_to_pay_zero_amountalready_paidinvalid_currencyvalidation_errors
object[] · required
AboPaymentFileType
AboPaymentItemData
sender_name
object · requiredvar_sym
object · requiredtotal_due
object · requiredaccount_number
object · requiredcurrency
object · required
AboPaymentItemError
AboPaymentSPD
value
string | nullerror
string | null
AcceptableSettingsKeys
AccountingConfidenceFieldSettingDto
key
string · required
warning_threshold
| null
AccountingConfidenceThreshold
AccountingConfidenceValidationParamsDto
warning_threshold
| nullfields
object[]
AccountingSystemDto
name
required
credentials
object
AccountingSystemEnum
AddUserRoleInQueueDto
id
string · uuid · requiredrole
required
AdvancedApprovalFeatureEnum
Document approval status
AdvancedApprovalStatusEnum
Document global approval status
AffectedEntitiesCountDto
affected
number · requirednot_affected
number · required
AffectedEntitiesCountResponseDto
data
object · required
AmountAggregateDto
sum
number · requiredavg
number · requiredmin
number · requiredmax
number · required
AmountAggregatesDto
currency
string · requiredaggregates
object · requiredcount
number · required
AmountAggregatesResponseDto
data
object[] · required
AnnotationDateValueDto
value
string | nulllabel
string | nullusage_counter
number | nullregion
| nullPosition of annotation in document
raw_annotation_indices
array | nullvalidation_result
| nullvalidation_results
array | nulldirect_user_input
booleanprobability
number | nulliso_date_value
string
AnnotationFieldDto
field
string · requiredvalues
required
AnnotationFieldRenderOptionDto
value
string | null · requiredlabel
string · required
label_key
string | null
AnnotationFieldRenderTypeEnum
AnnotationGlobalMessageDto
validation_result
| null · requiredfield
string | null · requiredsubfield
string | null · requiredfield_message
string | null · requiredsubfield_message
string | null · requiredfield_message_key
string | null · requiredsubfield_message_key
string | null · required
AnnotationGlobalStatusResponseDto
data
object · required
AnnotationNumericValueDto
value
string | nulllabel
string | nullusage_counter
number | nullregion
| nullPosition of annotation in document
raw_annotation_indices
array | nullvalidation_result
| nullvalidation_results
array | nulldirect_user_input
booleanprobability
number | nullnumeric_value
number
AnnotationSchemaColumnsDto
message
string · requiredkey
string · requireddatatype
requiredvisibility
requiredwidth
number | null · required
AnnotationSchemaDto
type
required
message
stringLabel for entity field shown in Digitoo App UI.
key
will be used if not provided. Mandatory only forsubtitle
type item.message_key
stringMessage key translation for entity field shown in Digitoo App UI.
key
will be used if not provided.key
stringEntity identifier. Mandatory only for
field
type item.datatype
Entity datatype. Mandatory only for
field
type item.numeric_type
Numeric type for numeric fields.
default_value
| nullDefault value to apply if no value extracted by engine.
hidden
booleanWhether an entity field should be initially hidden in UI.
false
will be used if not provided.hide_register_value
booleanWhether an register item should have visible value in Digitoo App UI.
false
will be used if not provided.required
booleanwhether an entity field should be required to have value before exporting.
false
will be used if not provided.autofill
string[]List of entities to initiate value from engine extracted values. Does not yet work for table entity subfields.
subfields
object[]List of entities for table entities (currently only
line_items
andtax_detail
are supported).multivalue
booleanWhether an entity field should be rendered as multivalue.
section_message_key
Adds sectionMessageKey in order to sort on
separator_key
stringAdds separatorKey in order to sort on
multiline
boolean | nullpattern_matching
| nullupdated_by_user
boolean | nullWhether schema field has been changed in Digitoo App UI.
AnnotationSchemaFieldDataTypeEnum
Entity datatype. Mandatory only for field
type item.
AnnotationSchemaFilterableFieldType
Type of returned filter
AnnotationSchemaNumericType
Numeric type for numeric fields.
AnnotationSchemaResponse
annotation_schema
object[] · requiredAn annotation schema
AnnotationSchemaSectionMessageKey
Adds sectionMessageKey in order to sort on
AnnotationSchemaSubfieldsDto
key
string · requiredEntity identifier. Mandatory only for
field
type item.
datatype
| nullEntity datatype. Mandatory only for
field
type item.message
stringLabel for entity field shown in Digitoo App UI.
key
will be used if not provided. Mandatory only forsubtitle
type item.hidden
booleanWhether an entity field should be initially hidden in UI.
false
will be used if not provided.required
booleanwhether an entity field should be required to have value before exporting.
false
will be used if not provided.default_value
| nullDefault value to apply if no value extracted by engine.
hide_register_value
boolean | nullWhether an register item should have visible value in Digitoo App UI.
false
will be used if not provided.pattern_matching
| nullupdated_by_user
boolean | nullWhether schema field has been changed in Digitoo App UI.
AnnotationSourceEnum
Document source
AnnotationTableField
Annotation table to be updated
AnnotationTableRowDto
validation_results
object[] · requiredvalidation_result
| null · requiredvalues
object[] · required
AnnotationTableValueTotalDto
field
string · requiredtotal
number · required
AnnotationValidationMessageSeverityEnum
AnnotationValueDto
value
string | nulllabel
string | nullusage_counter
number | nullregion
| nullPosition of annotation in document
raw_annotation_indices
array | nullvalidation_result
| nullvalidation_results
array | nulldirect_user_input
booleanprobability
number | null
AnnotationValueInput
value
string | null · requiredAnnotation value string to be set
region
| nullPosition of annotation in document
raw_annotation_indices
array | nullArray of annotation indices
AnnotationsFormattingEnum
AnnotationsGlobalStatusDto
export_allowed
boolean · requiredapprove_allowed
boolean · requiredannotations_edit_allowed
boolean · requiredskip_allowed
boolean · requireddeletion_allowed
boolean · requiredinitiate_approval_allowed
boolean · requiredmove_allowed
boolean · requiredmessage
| null · required
ApprovalAutomationDto
action
requiredaction_params
| null · requiredid
string · uuid · requiredname
string | null · requiredqueue_id
string · uuid · requiredcreated_at
string · date-time · requiredupdated_at
string · date-time · requiredconditions
object · required
validation_result
| null
ApprovalAutomationListResponseDto
data
object[] · required
ApprovalAutomationMatchResponseDto
data
| null · required
ApprovalAutomationResponseDto
data
object · required
ApprovalDocumentCountsData
to_approve
number · requiredreturns count of documents which could be approved by current user
approved
number · requiredreturns count of documents which had been approved by current user
rejected
number · requiredreturns count of documents which had been rejected
sent
number · requiredreturns count of documents which had been approved and sent to ERP
all
number · requiredreturns count of documents which had been approved by current user and has stage 'ALL'
ApprovalDocumentCountsResponseDto
data
requiredresponse data
ApprovalOrder
Document approval order
ApprovalRouteDto
id
string · uuid · requiredorder
requiredname
string · requiredExample: Scenarioname_with_users
string · requiredExample: Scenario (John Doe, ... +3)queue_id
string · uuid · requiredusers
object[] · required
ApprovalRouteItemDto
status
requireduser_id
string · uuid · requiredname
string · requiredmessage
string | null · required
ApprovalRouteResponseDto
data
requiredAn approval route
ApprovalRouteType
ApprovalRouteUserDto
id
string · uuid · requiredemail
string · email · requiredname
string · required
ApprovalRoutesResponseDto
data
object[] · requiredA list of approval routes
ApprovalStatusData
approval_enabled
boolean · requiredtrue if at least one queue has enabled approval
documents_to_approve_count
number · requiredcount of documents to approve
ApprovalStatusEnum
ApprovalStatusResponseDto
data
requiredresponse data
AttachmentDto
id
string · uuid · requiredcreated_at
string · date-time · requiredA datetime in ISO8601 with time zone
file_path
string · requiredfile_name
string · requiredmime_type
string · requiredfile_size
number · requiredfile_size_human_readable
string · requiredurl
string · required
AttachmentLinkBodyDto
entity_id
string · uuid · requiredentity_type
required
AutomationAssignApprovalRouteParams
approval_route_id
string · uuid · required
AutomationAssignApproversParams
approvers
string[] · requiredExample: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]
AutomationBinaryArrayConditionBaseDto
operation
requiredvariable
string · requiredvalues
string[] · required
validation_result
| null
AutomationBinaryArrayConditionDto
operation
requiredvariable
string · requiredvalues
string[] · requiredlabels
string[] · required
validation_result
| null
AutomationBinaryConditionDto
operation
requiredvariable
string · requiredvalue
requiredlabel
string | null · required
validation_result
| null
AutomationBinaryConditionEmailDto
operation
requiredvariable
string · requiredvalue
string · email · requiredlabel
string | null · required
AutomationBinaryConditionEmailRawDto
operation
requiredvariable
string · requiredvalue
string · email · required
AutomationBinaryConditionRawDto
operation
requiredvariable
string · requiredvalue
required
validation_result
| null
AutomationBinaryConditionUUIDDto
operation
requiredvariable
string · requiredvalue
string · uuid · requiredlabel
string | null · required
AutomationBinaryConditionUUIDRawDto
operation
requiredvariable
string · requiredvalue
string · uuid · required
AutomationConditionsDto
operation
requiredconditions
array · required
AutomationConditionsRawDto
operation
requiredconditions
array · required
AutomationNestedConditionDto
operation
requiredconditions
array · required
validation_result
| null
AutomationNestedConditionRawDto
operation
requiredconditions
array · required
validation_result
| null
AutomationRuleAction
AutomationRuleValidationResult
message_key
string · required
AutomationRules
AutomationSupportedBinaryArrayOperation
AutomationSupportedBinaryOperation
AutomationSupportedNestedOperation
AutomationSupportedOperation
AutomationSupportedUnaryOperation
AutomationUnaryConditionBaseDto
operation
requiredvariable
string · required
validation_result
| null
AutomationUnaryConditionDto
operation
requiredvariable
string · required
validation_result
| null
BankAccountResponseDto
currency
requiredExample: CZKid
string · uuid · requiredname
string | null · minLength: 1 · maxLength: 16 · requiredaccount_number
string · requirediban
string | null · requiredswift
string | null · required
BillingSessionCheckout
checkout_url
string | null · url · requiredURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
success_url
string | null · url · requiredURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
cancel_url
string | null · url · requiredURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
BillingSessionCheckoutResponse
data
object · required
BillingVerification
status
string · required
BillingVerificationResponse
data
object · required
BulkApproveDocumentsDto
filters
object · requiredqueue_id
string · uuid · required
search
string | null
BulkApproveOrganizationDocumentsDto
filters
object · requiredorganization_ids
string[] · requiredExample: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]
search
string | null
BulkInitiateApprovalDocumentsDto
filters
object · requiredqueue_id
string · uuid · required
search
string | null
BulkInitiateApprovalOrganizationDocumentsDto
filters
object · requiredorganization_ids
string[] · requiredExample: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]
search
string | null
BulkPurgeDocumentsDto
filters
object · requiredqueue_id
string · uuid · required
search
string | null
BulkRejectDocumentsDto
filters
object · requiredqueue_id
string · uuid · requiredrejection_reason
string · required
search
string | nullreject_document
boolean | null
BulkRejectOrganizationDocumentsDto
filters
object · requiredorganization_ids
string[] · requiredExample: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]rejection_reason
string · required
search
string | nullreject_document
boolean | null
ChangePasswordRequestDto
token
string · requiredToken used to request password change
password
string · required
ChangePasswordResponseDto
data
object · required
ContactIntegrationPartnerDto
email
string · requiredphone
string · requiredintegration_id
string · uuid · requiredorganization_id
string · uuid · required
message
string | null
CreateBankAccountDto
currency
requiredworkspace_id
string · uuid · requiredname
string · minLength: 1 · maxLength: 16 · requiredaccount_number
string · requirediban
string | null · requiredswift
string | null · required
CreateBankAccountResponseDto
data
object · required
CreateOrganizationDto
name
string · requiredOrganization name
CreateQueueDto
type
requiredname
string | null · minLength: 1 · requiredA name of a queue
locale
requiredcurrency
string · minLength: 1 · requiredCurrency assigned to the queue (ISO code)
approval
boolean | nullWhether to use approval flow
extraction
boolean | nullWhether to allow extraction of documents
Default:
CreateQueuesDto
queues
object[] · required
CreateScheduledTaskDto
export_type
required
sort
objectsearch
string | nullexport_file_name_options
string[]Enum values:sender_namesender_register_idinvoice_idinternal_erp_idoriginal_filenameexport_options
objectfilters
objectexport_entities
string[]Enum values:attachmentsdocumentsaudit_logs
CreateUserRequest
email
string · email · requiredphone
string · requiredUser phone
ui_locale
required
CreateWebhookDto
url
string · url · requiredURL must be a valid HTTP URL
entity_type
requiredentity_id
string · uuid · required
type
| nullDefault: document_status_changedsignature_verification
| null
CreateWorkspaceDto
name
string · requiredregion
requiredorganization_id
string · uuid · requiredaccounting_system
object · requiredqueue_options
object[] · required
company_id_number
stringA valid company ID number
tax_id
stringvat_id
stringintegration_id
string | null · uuid
CurrencyCode
DashboardPaginationDto
next_document
string | null · uuid · requiredprevious_document
string | null · uuid · requiredposition
number · requiredtotal_count
number · required
DashboardPaginationResponseDto
data
object · required
Data
connection_status
required
DateAggregationDataDto
date
string · date-time · requiredduration
number · requireddata
object[] · required
DeleteDocumentRegistersDto
registers
object[] · required
DeleteQueueRegistersDto
registers
object[] · requiredqueue_id
string · uuid · required
DeleteRegisterOption
value
string · required
DeleteRegisterRequest
type
string · requiredoptions
object[] · required
DemoInitializeBodyDto
locale
required
DemoInitializeResponseDataDto
magic_link
string · url · requiredURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
DemoInitializeResponseDto
data
object · required
DocumentAggregationDataDto
queue_id
string · uuid · requiredqueue_name
string · requiredqueue_humanized_id
number · requiredworkspace_id
string · requiredworkspace_name
string · requiredworkspace_humanized_id
number · requireddocument_id
string · uuid · requireddocument_page_count
number · requiredduration
number · requireddata
object[] · required
DocumentAnnotationsDto
data
object · 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}]}]}
DocumentApprovalDto
id
string · uuid · requiredapproval_route_id
string | null · uuid · requiredapproval_route_type
| null · requiredapproval_feature
requiredapproval_process
object[] · requiredapproval_status
requiredroute_name
string | null · requiredapproval_route_order
required
DocumentApprovalResponseDto
data
object · required
DocumentApprovalRouteDto
order
requiredusers
object[] · required
DocumentApprovalRouteResponseDto
data
object · required
DocumentAuditLogDto
id
number · requiredcreated_at
string · date-time · requireddocument_id
string · uuid · requiredevent
requiredDocument event
new_value
string | null · requiredprevious_value
string | null · requireduser_id
string · uuid · requireduser_name
string · requiredmetadata
| null · required
DocumentAuditLogEvent
Document event
DocumentAuditLogHumanizedDocumentDto
imported_at
string · date-time · requiredimported_via_email
boolean · requiredfilename
string · required
sender_address
string | null
DocumentAuditLogHumanizedItemDto
date
string · date-time · requiredoperation
requiredtext
string · requireduser_id
string · uuid · required
DocumentAuditLogHumanizedOperation
DocumentAuditLogHumanizedResponseDto
data
object[] · requiredarray of response data
pagination
requiredpagination
document
object · required
DocumentAuditLogMetadataDto
field_message
string | nullrow_index
numbertable
string | null
DocumentAuditLogResponseDto
data
object[] · requiredarray of response data
pagination
requiredpagination
DocumentByPaymentStatusAggregatorResultDto
unpaid
number · requiredpaid
number · requiredto_pay
number · requiredpayment_order
number · requiredpast_due
number · required
DocumentByStageAggregatorResultDto
to_approve
number · requiredto_validation
number · requiredlater
number · requiredsent
number · requireddeleted
number · requiredrejected
number · requiredspam
number · requiredtotal
number · required
DocumentDuplicityDto
id
string · uuid · requiredstage
requiredstatus
requiredsource
requiredlast_status_changed_at
string | null · date-time · requiredDate of last status change
document_url
string · requiredDocument url
DocumentEditsDto
pages
object[] · required
DocumentExportQueryDto
type
requiredFile export type
export_columns_options
| nullexport_file_name_options
string[]Enum values:sender_namesender_register_idinvoice_idinternal_erp_idoriginal_filenameexport_line_items
| null
DocumentInboxStatus
DocumentIncludeFieldsEnum
DocumentIncludeLockedBy
id
string · uuid · requiredemail
string · email · required
DocumentIncludeOrganization
id
string · uuid · requiredhumanized_id
number · requiredname
string · requiredstatus
required
DocumentIncludeQueue
id
string · uuid · requiredhumanized_id
number · requiredtype
required
name
string | null
DocumentIncludeShareStatus
share_enabled
boolean · requiredshare_url
string | null · required
DocumentIncludeWorkspace
id
string · uuid · requiredname
string · required
DocumentLockStatusEnum
DocumentLockStatusGetterResult
locked_at
string · date-time · requiredlocked_by
requiredUser who locked the document
locked
boolean · requiredIs document locked
locked_by_current_user
boolean · requiredIs document locked by current user
locked_for_current_user
boolean · requiredIs document locked for current user
DocumentLockStatusUser
id
string · uuid · requiredname
string | null · requiredemail
string · email · required
DocumentMetadataDto
id
string · uuid · requiredconfidence
number | null · requiredcreated_at
string · date-time · requiredupdated_at
string · date-time · requiredqueue_id
string · uuid · requiredAn ID of an associated Queue
status
requiredpage_count
number · requiredfile_name
string · requiredextraction_error
string | null · requiredline_items_visibility
requiredtax_detail_visibility
requiredemail_id
string | null · requiredinbox_status
| null · required
export_version_id
string | null · uuidGenerated new identifier whenever document is exported (again)
internal_erp_id
string | nullAn internal ID from the ERP system
export_error
string | nullexport_error_description
string | nullmarked_as_exported_at
string | nullmarked_as_exporting_at
string | nullmarked_as_ready_to_export_at
string | nullA datetime in ISO8601 with time zone of a moment when a user marks a document to be ready to export to the ERP (Send button in the UI)
received_from
string | null
DocumentMetadataResponseDto
data
object · required
DocumentOcrDataResponseDto
data
object[] · required
DocumentPageEditsDto
page_index
number · requiredPage index of the parent document
rotation
| null
DocumentPageImageDto
width
number · requiredheight
number · requiredpage_number
number · requiredsigned_url
string · requiredmime_type
string · required
DocumentPaginationDto
next_document
string | null · uuid · requiredprevious_document
string | null · uuid · requiredposition
number · requiredtotal_count
number · required
DocumentPaginationResponseDto
data
object · required
DocumentRegistersApiResponse
data
object[] · requiredfrequent_items
object[] · requiredpagination
object · required
DocumentRotationEdit
DocumentSection
DocumentSectionVisibility
DocumentStageEnum
Document stage
DocumentStatusChangeWithUserType
changed_at
string · date-time · requiredchanged_to
requiredchanged_by
string | null · requiredtype
| null · requiredchanged_by_id
string | null · requiredchanged_by_user_email
string | null · required
DocumentStatusEnum
DocumentTimeSpentStage
DocumentValidationStatusItem
message
string | null · requiredseverity
requiredmessage_key
requireddescription_key
string · requireddescription
string · required
DocumentValidationStatusResponse
data
object[] · required
DocumentWithIncludeExcludeMetadataDto
id
string · uuid · requiredconfidence
number | null · requiredcreated_at
string · date-time · requiredupdated_at
string · date-time · requiredqueue_id
string · uuid · requiredAn ID of an associated Queue
status
requiredpage_count
number · requiredfile_name
string · requiredextraction_error
string | null · requiredline_items_visibility
requiredtax_detail_visibility
requiredemail_id
string | null · requiredinbox_status
| null · requiredannotations
object · 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}]}current_approver_ids
string[] · requiredapproval_process
object[] · requiredadvanced_approval_route_name
string | null · requiredadvanced_approval_feature
requiredDocument approval status
locked_by_user
| null · requiredDocument locked by user
lock_status
| null · requiredDocument lock status
current_approver_label
string | null · requiredCurrent approver name or email
current_approver_labels
string[] · requiredCurrent approvers name or email
stage
requiredDocument stage
rejection_reason
string | null · requiredRejection reason
annotations_source
requiredDocument source
export_allowed
boolean · requiredBoolean flag if document can be exported
approve_allowed
boolean · requiredBoolean flag if document can be approved
move_allowed
boolean · requiredBoolean flag if document can be moved
initiate_approval_allowed
boolean · requiredBoolean flag if document approval can be started
annotations_edit_allowed
boolean · requiredBoolean flag if document annotations can be edited
skip_allowed
boolean · requiredBoolean flag if document can be skipped
deletion_allowed
boolean · requiredBoolean flag if document can be deleted
last_status_change
| null · requiredLast document status change
status_change_history
object[] · requiredLast document status change
page_images
object[] · requiredA list of document page images
page_edits_history
object[] · requiredocr_data
object[] · requiredreceived_from_name
string | null · requireduploaded_by_name
string | null · requiredemail_subject
string | null · required
export_version_id
string | null · uuidGenerated new identifier whenever document is exported (again)
internal_erp_id
string | nullAn internal ID from the ERP system
export_error
string | nullexport_error_description
string | nullmarked_as_exported_at
string | nullmarked_as_exporting_at
string | nullmarked_as_ready_to_export_at
string | nullA datetime in ISO8601 with time zone of a moment when a user marks a document to be ready to export to the ERP (Send button in the UI)
received_from
string | nullorganization
| nullDocument's organization
workspace
| nullWorkspace of document's queue
queue
| nullDocument's queue
approved_by_current_user
boolean | nullIs document approved by current user
advanced_approval_status
| nullDocument global approval status
payment_status
| nullDocument payment status
payment_status_label
string | nullDocument payment status label
document_url
string | nullDocument url
has_duplicities
boolean | nullBoolean flag if document has duplicities
has_attachments
boolean | nullBoolean flag if document has attachments
last_modified_at
string | nullreceived_at
string | nullfirst_page_image
string | nullshare_status
| nullDocument's share status
advanced_approval_order
| nullDocument approval order
DocumentWithNextDocumentMetadata
document
object · requirednext_document
| null · required
DocumentWithNextDocumentMetadataResponseDto
data
object · required
DocumentsAggregatedCounts
by_stage
object · requiredby_payment_status
object · required
DocumentsApiResponse
data
object[] · requiredarray of response data
pagination
requiredpagination
DocumentsCountAggregatedDto
uploaded
number · requiredNumber of documents to approve and to validate
sent
number · requiredNumber of sent documents
date
string · date-time · requiredworkspaces
object[] · required
count
number · deprecated · requiredDeprecated, use "uploaded" instead
DocumentsCountPerDay
count
number · required
DocumentsCountPerQueueAggregatedDto
queue_id
string · uuid · requiredqueue_name
string · requiredqueue_humanized_id
number · requireduploaded
number · requiredNumber of documents to approve and to validate
sent
number · requiredNumber of sent documents
DocumentsCountPerWorkspaceAggregatedDto
workspace_id
string · requiredworkspace_name
string · requiredworkspace_humanized_id
number · requireduploaded
number · requiredNumber of documents to approve and to validate
sent
number · requiredNumber of sent documents
queues
object[] · required
DocumentsToApproveDto
data
object[] · requiredA list of documents
EditPagesDto
documents
object[] · minItems: 1 · required
original_document_change_action
| null
EditPagesResponse
document_ids
string[] · required
EmailDto
id
string · uuid · requiredcreated_at
string · date-time · requiredA datetime in ISO8601 with time zone
updated_at
string · date-time · requiredA datetime in ISO8601 with time zone
from
string · requiredsubject
string · requiredbody_plain_text
string · requiredbody_html
string · required
EmailWithRolesInWorkspaceQueuesDto
email
string · email · requiredworkspaces
object[] · required
EmbeddedAccessRequestDto
return_url
string · urlAn url to redirect after embedded document is processed
cancel_url
string · urlAn url to redirect after embedded document is cancelled
user_id
string | null · uuidAnother user id to create embedded access for
EmbeddedAccessResponseDataDto
data
object · required
EmbeddedAccessResponseDto
token
string · requiredembedded_url
string · url · requiredURL must be a valid HTTP URL
return_url
string | null · url · requiredURL must be a valid HTTP URL
cancel_url
string | null · url · requiredURL must be a valid HTTP URL
embedded_token_user_id
string · uuid · requiredembedded_token_user_ui_locale
required
EmitIntegrationConnectionStatusChange
workspace_id
string · uuid · requireddata
object · required
EmitSseDocumentExtracted
queue_id
string · uuid · requireddata
object · required
EmitSseNotificationReceived
organization_id
string · uuid · requireddata
object · required
EnqueueDocumentsToExtractionDto
queue_id
string · uuid · requiredAn ID of a queue
ids
array | nullComma separated document ids
search
stringfilters
| null
EnqueueToExtractionFilters
ids
array | nullComma separated document ids
EntityTypeEnum
ErpListCurrentReleaseDto
version
string · requiredregion
string · requiredlink
string · requiredrelease_notes
string · requiredpublication_date
string · date · required
ErpListIntegrationDto
id
string · uuid · requiredlogo
string | null · requiredname
string · requiredaccounting_system
requiredapi_version
required
ErpListItemDto
integration
object · requiredworkspace
object · requiredlegacy_token
string | null · requiredLegacy V1 workspace token
token
string | null · requiredService account token
current_release
| null · required
ErpListWorkspaceDto
id
string · uuid · requiredname
string · requiredversion
string | null · requiredhumanized_id
number · requiredaccess_actions
string[] · requiredEnum values:readupdatedeleteupload-documentupdate-documentupdate-document-stagelock-documentvalidate-annotations
ExcludeFieldsEnum
ExportColumnEnum
ExportFileNameSourceEnum
ExportOptionsDto
export_line_items
boolean | nullexport_columns_options
| null
ExportableEntity
ExtractionEvaluation
ExtractionEvaluationConfidence
ExtractionEvaluationDto
document_confidence
| null · requiredfields
object[] · required
ExtractionEvaluationFieldDto
confidence
| null · requiredfield
string · required
validation_result
string | null
ExtractionEvaluationResponseDto
data
object · required
ExtractionLocale
FeatureFlagsDto
billing
boolean | nullannotation_detail
boolean | nulldrive_upload
boolean | nullinbox
boolean | nullbulk_user_update
boolean | nullpurge_documents
boolean | nullglobal_search
boolean | nullapprover_action
boolean | null
FieldFormattingStatus
FileExportTypeEnum
File export type
FilterableFieldData
key
string · requiredAnnotation schema field key
message
string · requiredAnnotation schema field message
filter_type
requiredType of returned filter
FilterableFieldsResponse
data
object[] · required
FiltersDocumentStatusChangeDto
source
| null
FiltersQueryMetadataDto
ids
array | nullComma separated document ids
stage
string[]Comma separated document stage
Enum values:to-validationto-approvelatersentdeletedrejectedspamnonestatus
string[]Comma separated document status
Enum values:receivedenqueued-for-extractionextraction-erroredextraction-rejectedwaiting-for-human-validationwaiting-for-human-approvaldeletedpostponedpayment_status
string[]Comma separated document payment status
Enum values:paidunpaidto_paypayment_orderpast_dueinbox_status
string[]Comma separated document inbox status
Enum values:sortedunsortedlast_modified_date_gte
string | null · date-timelast_modified_date_lte
string | null · date-timelast_status_change_at_gte
string | null · date-timelast_status_change_at_lte
string | null · date-timecreated_at_gte
string | null · date-timecreated_at_lte
string | null · date-timelast_modified_by
array | nullcurrent_approver_id
string | null · uuidcurrent_approver_ids
array | nullglobal_approval_status
string[]Enum values:undeterminedinitiatedpendingapproveddeclinedadvanced_approval_status
string[]Enum values:undeterminedinitiatedpendingapproveddeclinedapproval_status
string[]Enum values:enableddisabledadvanced_approval_feature
approval_route_users
array | nullapproval_process_users
array | nullapproved_by_users
array | nullworkspace_id
array | nullorganization_id
array | nullreceived_from
array | nullsource
| nulladvanced_approval_route_name
array | null
FrequentItemsDto
enabled
boolean · requiredannotation
string · requiredsize
number · required
GetAboPaymentDataAux
document_id
string · uuid · requiredpayment_status
requirederrors
string[] · requiredEnum values:missing_fieldmissing_valueinvalid_bank_accountunable_to_pay_negative_amountunable_to_pay_zero_amountalready_paidinvalid_currencyerror_messages
string[] · requiredeligible_to_pay_abo
boolean · requiredeligible_to_pay_qr
boolean · requiredabo_data
object · requiredqr_data
object · required
GetAboPaymentDataResponse
data
object[] · required
GetAgentVersionsDataDto
id
string · uuid · requireddownload_link
string · uri · requiredversion
string · requirednotes
string · requiredregion
requiredcreated_at
string · date-time · required
GetAgentVersionsDto
data
object[] · required
GetAnnotationConfidenceResponseDto
data
object · requiredA list of annotations confidences
GetAnnotationValuesResponseDto
data
object · 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}]}
GetBankAccountsResponseDto
data
object[] · required
GetDocumentAttachmentsDto
data
object[] · required
GetDocumentDuplicitiesResponseDataDto
duplicities_count
number · requirednumber of existing duplicities
duplicities
object[] · requiredList of all duplicities
GetDocumentDuplicitiesResponseDto
data
object · required
GetDocumentsCountAggregatedDto
data
object[] · required
GetDocumentsCountDto
data
object · required
GetEmailAttachmentsDto
data
object[] · required
GetEmailResponseDto
data
object · required
GetLineItemsTemplateDto
data
object · required
GetLineItemsTemplatesDto
data
object[] · required
GetLinkedAccountsResponse
data
object[] · required
GetRefreshTokenDto
data
object · required
GetSepaPaymentDataAux
document_id
string · uuid · requiredpayment_status
requirederrors
string[] · requiredEnum values:missing_fieldmissing_valueinvalid_ibaninvalid_biccountry_mismatch_iban_bicunable_to_pay_negative_amountunable_to_pay_zero_amountalready_paiderror_messages
string[] · requiredeligible_to_pay_sepa
boolean · requiredsepa_data
object · required
GetSepaPaymentDataResponse
data
object[] · required
GetStatusChangeCountsAggregatedDto
data
object[] · required
GetStatusChangeCountsDto
data
object[] · required
GetStatusHistoryCountsDto
data
object[] · required
GetSubjectCountry
GetSubjectDto
name
string · requiredaddress
string · requiredstreet
string · requiredcity
string · requiredpost_code
string · requiredcountry
string · required
GetSubjectResponse
data
object · required
GetTimeSpentHistoryReportResponseDto
data
object[] · required
GetTimeSpentPerDocumentReportResponseDto
data
object[] · required
GetTimeSpentPerSessionReportResponseDto
data
object[] · required
GetTimeSpentPerUnitReportResponseDto
data
object[] · required
GetTimeSpentPerUserReportResponseDto
data
object[] · required
GetTokenResponseDto
data
object · required
GetWorkspaceIntegrationStatusResponseDto
data
object · required
HighestUserRoleInOrganizationDto
organization_id
string · uuid · requiredhighest_role
required
InboxDocumentCountsData
unsorted
number · requiredreturns count of inbox documents which were not sorted automatically
sorted
number · requiredreturns count of inbox documents which were sorted
spam
number · requiredreturns count of inbox documents which are considered spam
deleted
number · requiredreturns count of inbox documents which have been deleted
total
number · requiredreturns count of all inbox documents
InboxDocumentCountsResponseDto
data
requiredresponse data
InboxQueueDto
id
string · uuid · required
IncludeFilterMetadataEnum
IntegrationAPIVersion
IntegrationAuthType
IntegrationCertification
IntegrationConnectionStatusEnum
Connection status of workspace
IntegrationDto
id
string · uuid · requiredname
string · requirederp_code
requiredregion
requiredlogo
string · requiredservice_url
string | null · url · requiredtype
requiredstatus
requiredauth_type
requiredcertification
requiredsettings
object · required
IntegrationLogDto
type
requiredEvent type
message
string · requiredHuman-readable message for user
document_id
string · uuidDocument ID reference in case an event is directly associated to the document
details
objectAn object used for storing miscellaneous data related to the event and used for debugging
IntegrationResponseDto
data
object · required
IntegrationSettingsDto
queue_types
string[] · requiredEnum values:issued-invoicereceived-invoicereceiptcontract-orderinboxother
alternative_title
string | nullalternative_description
string | nullsubtitle
| nullpartner
| null
IntegrationSettingsPartnerDto
name
string · required
logo
string | nullname_visibility
| null
IntegrationSettingsSubtitleDto
text
string · required
tooltip
| null
IntegrationSettingsSubtitleTootlipDto
title
string · required
subtitle
string | null
IntegrationStatus
IntegrationStatusDto
erp_code
requiredconnection_status
requiredglobal_error
string | null · requiredIntegration error
global_error_description
string | null · requiredIntegration error description
version
string | null · requiredIntegration version
update_available
| null · requiredNew version of integration
token
string · requiredintegration
object · required
IntegrationStatusUpdateAvailableDto
version
string · requiredNew version of integration
link
string · requiredDownload link of the new integration version
IntegrationType
IntegrationsResponseDto
data
object[] · required
InternalRegistersApiResponse
data
object[] · requiredpagination
object · required
LineItemsDataResponse
line_items
object[] · requiredtotals
object[] · required
LineItemsResponseDto
data
object · requiredpagination
object · required
LineItemsRestorationSource
LineItemsTemplate
id
string · uuid · requiredname
string · required
LinkedAccountDto
id
string · uuid · requiredemail
string · requiredtype
requiredcreated_at
string · date-time · required
LinkedSocialAccountType
LockStatusRequestDto
lock_status
required
LockStatusResponseDataDto
data
requiredDocument lock status
LogTypeEnum
Event type
LoginRequestDto
email
string · email · requiredpassword
string · required
MagicSignInRequestDto
token
string · required
MagicSignInResponseDto
data
object · required
ManageableUserDto
highest_role_in_organization
requireduser
object · requiredis_manageable
boolean · requiredworkspaces
object[] · required
ManageableUserResponseDto
users
object[] · requiredworkspaces
object[] · requiredqueues
object[] · required
ManageableUsersResponseDto
data
object · required
MarkBasicAnnotationSeenInputDto
field
string · requiredAnnotation field to be updated
index
numberZero based index of the annotation value of a field. Mostly used for multivalue fields.
MarkSeenTableAnnotationAuxDto
annotation_changes
object[] · requiredregister_changes
object[] · requiredglobal_status
| null · requiredAnnotations global status
MarkSeenTableAnnotationResponseDto
data
object · required
MarkTableAnnotationSeenInputDto
field
string · requiredAnnotation field to be updated
table_key
requiredAnnotation table to be updated
row_index
number · requiredAnnotation table row index (0-based) to be updated
index
numberZero based index of the annotation value of a field. Mostly used for multivalue fields.
MembershipAccessActions
MembershipRoleEnum
MoveDocumentsDto
queue_id
string · uuid · required
filters
objectsort
objectpagination
objectsearch
string | nullre_extraction
| null
MoveDocumentsResponseDto
affected
number · requirednot_affected
number · requireddocuments_ids
string[] · required
NotificationFiltersDto
status
string[]Enum values:seenunseendismissed
NotificationSettingsDto
approval_action_email
boolean · requiredapproval_summary_email
boolean · requiredin_app_notifications
boolean · required
NotificationSortDirection
NotificationSortDto
field
requireddirection
required
NotificationSortEnum
NotificationStatus
NotificationType
NullableWebhookSigningKeyDto
webhook_signing_key
string | null · required
NullableWebhookSigningKeyResponseDto
data
object · required
OrganizationDto
id
string · uuid · requiredhumanized_id
number · requiredname
string · requiredtax_id
string | null · requiredvat_id
string | null · requiredregister_id
string | null · requiredhouse_number
string | null · requiredstreet
string | null · requiredcity
string | null · requiredzip
string | null · requiredcountry
string | null · requiredstatus
requiredinbox_status
required
access_actions
string[]Enum values:readupdatedeleteupload-documentupdate-documentupdate-document-stagelock-documentvalidate-annotationsapproval_metadata
| nullfirst_queue_id
number | nullinbox_queue
| nullsettings
objectuser_settings
objectwebhook_signing_key
object | null
OrganizationErpListResponseDto
data
object[] · required
OrganizationInboxStatus
OrganizationIncludeFields
OrganizationResponseDto
data
object · required
OrganizationSettingsDto
annotation_schema_columns
object[] · requiredpossible_schema_columns
object[] · requiredmerged_annotation_schema
object[] · required
OrganizationSettingsResponseDto
data
object · required
OrganizationStatusEnum
OrganizationUnitsCountResponseDto
data
object · required
OrganizationUserSettingsDto
workspace_order_by
requiredworkspace_order_direction
required
OrganizationsResponseDto
data
object[] · required
OrganizationsUnitsCountDto
workspaces_count
number · requiredqueues_count
number · requiredcan_create_workspace
boolean · requiredcan_create_queue
boolean · required
OriginalDocumentChangeActionStrategy
OtpStatus
PageEditHistoryDto
pages
object[] · requiredparent_document_id
string · uuid · requirededited_at
string · date-time · requirededited_by
string · uuid · required
PaginationDto
page_number
number · requiredpage_size
number · requiredtotal_count
number · requiredpage_count
number · requiredhas_previous_page
boolean · requiredhas_next_page
boolean · required
PaginationQuery
number
number · min: 1The page number, starting from 1
Default: 1size
number · min: 1 · max: 1000
PartialAnnotationSchemaFieldDto
key
string | nulloptions
object[]multivalue
boolean | nullmessage
string | nullformatting
| nullhidden
boolean | nullsubfields
object[]section_message_key
| nullseparator_key
string | nullloose
boolean | nullrequired
boolean | nulldatatype
| nullautofill
array | nullpattern_matching
| nulldefault_value
| nullhide_register_value
boolean | nullmultiline
boolean | nullaccuracy_threshold
numberrequired_for_auto_send
boolean | nullfrequent_items
| nullnumeric_type
| nullmax_length
number
PartialAnnotationSchemaSubfieldDto
key
string · required
multivalue
boolean | nullformatting
| nullhidden
boolean | nullmessage
string | nullmessage_key
string | nullrequired
boolean | nulldatatype
| nulldefault_value
| nullhide_register_value
boolean | nullautofill
array | nullpattern_matching
| nullaccuracy_threshold
numbermax_length
number
PartnerNameVisibility
PasswordChangeDto
user_locale
requiredtoken
string · required
PasswordChangeTokenResponseDto
data
object · required
PatchAnnotationColumnItem
key
string · requiredvisibility
boolean · required
width
number | null
PatchAnnotationColumnsInput
columns
object[] · required
PatchAnnotationSchemaBodyDto
annotation_fields
object[] · required
PatchApprovalAutomationDto
action
action_params
| nullname
string | nullconditions
object
PatchDocumentApprovalActionDto
new_approver
string | null · requiredstatus
required
message
stringnext_document
| null
PatchDocumentApprovalDto
status
required
PatchDocumentApprovalResponseDto
data
object · required
PatchDocumentApprovalRouteDto
approval_route_id
string | null · uuid · required
PatchDocumentApprovalWithNextDocumentDto
id
string · uuid · requiredapproval_route_id
string | null · uuid · requiredapproval_route_type
| null · requiredapproval_feature
requiredapproval_process
object[] · requiredapproval_status
requiredroute_name
string | null · requiredapproval_route_order
requirednext_document
string | null · uuid · required
PatchDocumentShareStatusRequestDto
share_enabled
boolean · requiredTrue for enable, false for disable
PatchDocumentShareStatusResponseDto
data
object · required
PatchDocumentStatusDto
status
requiredNew document status
internal_erp_id
string | nullReturned internal document id from ERP. Applied only if new status is exported
export_error
string | nullError message from ERP. Applied only if new status is export-errored
export_error_description
string | nullError description from ERP. Applied only if new status is export-errored
PatchInboxStatusBodyDto
inbox_status
required
filters
objectsort
| nullpage
| nullsearch
string | null
PatchInboxStatusResponseDataDto
affected
number · requirednot_affected
number · required
PatchInboxStatusResponseDto
data
object · required
PatchInternalErpIdDto
internal_erp_id
string | null · required
PatchLineItemsTemplateInput
name
string · maxLength: 100 · required
PatchNextDocumentDto
filters
objectsort
| nullsearch
string | null
PatchNotificationFiltersDto
ids
string[]Example: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]statuses
string[]Enum values:seenunseendismissed
PatchNotificationsStatus
filters
object · requiredstatus
required
PatchOrganizationInputDto
name
stringvat_id
string | nulltax_id
string | nullregister_id
string | nullhouse_number
string | nullstreet
string | nullcity
string | nullcountry
stringinbox_status
| nullzip
string
PatchOrganizationResponseDto
data
object · required
PatchOrganizationWorkspaceOrderingRequest
field
requireddir
required
PatchPushTokenStatusDto
status
required
PatchQueueAutomationRulesDto
status
required
PatchQueueDto
name
string | nullinbox_hash_prefix
stringExample: main-workspace.received-invoices
PatchQueueExtractionEvaluationDto
status
required
PatchSectionVisibilityRequest
section
requiredvisibility
required
PatchSectionVisibilityResponse
data
object · required
PatchSectionVisibilityResponseData
section
requiredvisibility
required
PatchSetPaymentStatusBodyDto
status
required
PatchUserLanguageRegionDto
ui_locale
required
PatchUserNameDto
name
string | null
PatchUserNotificationSettingsDto
approval_action_email
boolean | nullWhether to send an email when new approval for document is requested
approval_summary_email
boolean | nullWhether to send an email with summary of documents with requested approval
in_app_notifications
boolean | nullWhether to show in-app notifications
PatchWorkspaceConnectionStatusDto
integration_connection_status
requiredConnection status of workspace
global_error
stringGlobal error of workspace eg. connection issues
global_error_description
string | nullGlobal error description of workspace eg. connection issues
PatchWorkspaceDto
name
string | null · minLength: 1A name of the workspace
register_id
string | nulltax_id
string | nullvat_id
string | nullicon_color
string | null · pattern:^#?([0-9A-F]{3}|[0-9…
PatternMatchingChunkingStrategy
PatternMatchingDto
pattern
string · required
chunking_strategy
| nulltransform_chunks
array | null
PatternMatchingParamsDto
pattern
string · requiredchunking_strategy
required
transform_chunks
string[]
PaymentStatus
Document payment status
PostAnnotationTableAppendRowRequestDto
table_key
requiredExample: line_items
PostAnnotationTableDuplicateRequestDto
table_key
requiredExample: line_itemsindex
number · requiredAnnotation table row index (0-based) to be duplicated
PostAnnotationTableRemoveAllRequestDto
table_key
requiredExample: line_items
PostAnnotationTableRemoveRowRequestDto
table_key
requiredExample: line_itemsindex
number · requiredAnnotation table row index (0-based) to be removed
PostApprovalAutomationDto
action
requiredaction_params
| null · requiredname
string | null · requiredconditions
object · required
PostApprovalRouteDto
order
requiredusers
string[] · minItems: 1 · requiredname
string · required
PostBulkMoveDocumentsResponseDto
data
object · required
PostBulkPaymentRequest
filters
object · requiredpayment_status
required
search
string | null
PostConnectLinkedAccountResponseDto
data
object · required
PostDocumentForgetBodyDto
field_key
string · required
PostDocumentLearnBodyDto
annotations
object · 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}]}]}
line_items_visibility
| nulltax_detail_visibility
| null
PostDocumentWithNextDocumentDto
lock_next_document
boolean · requirednext_document
object · requiredstage
required
rejection_reason
string | null
PostDocumentsStageDto
filters
object · requiredqueue_id
string · uuid · requiredstage
required
rejection_reason
string | nullsearch
string | null
PostFreeSubscriptionDto
products
object[] · required
PostInviteUsers
email_with_roles_in_workspace_queues
object[] · required
PostInviteUsersResponseDto
data
string[] · requiredsuccessfully_invited_user_emails
string[] · requiredunsuccessfully_invited_user_emails
string[] · required
PostLineItemsTemplateInput
name
string · maxLength: 100 · requireddocument_id
string · uuid · required
PostMailDocumentSharingLinkRequestDto
email
string · email · requiredEmail on which the share link will be sent
PostQueueSetSchemaVisibilityInputDto
fields
object[] · requiredA list of fields to update
PostRelearnBodyDto
name
string | null · requiredregister_id
string | null · requiredtax_id
string | null · requiredvalue
string | null · requiredfield_key
string · required
PostSessionCheckoutDto
products
object[] · required
coupon_id
string | nullsuccess_url
string | nullcancel_url
string | null
PostSocialLoginRequestDto
email
string · email · requiredid_token
string · required
PushTokenStatus
PutApplyLineItemsTemplateInputDto
template_id
string · uuid · required
PutApprovalRouteDto
order
requiredusers
string[] · minItems: 1 · required
name
string
PutDocumentApprovalRouteDto
order
requiredusers
string[] · required
QueueApiResponse
data
object · required
QueueCreationOptionsDto
type
requiredname
string | null · minLength: 1 · requiredA name of a queue
locale
requiredcurrency
string · minLength: 1 · requiredCurrency assigned to the queue (ISO code)
approval
boolean | nullWhether to use approval flow
extraction
boolean | nullWhether to allow extraction of documents
Default:
QueueDocumentsCountResponseDto
data
requiredDocuments aggregated counts for queue
QueueDto
id
string · uuid · requiredhumanized_id
number · requiredcreated_at
string · date-time · requiredA datetime in ISO8601 with time zone
type
requiredcurrency
string · requiredworkspace_id
string · uuid · requiredinbox_hash
string · requiredinbox_hash_prefix
string · requiredExample: main-workspace.received-invoicesinbox
string · requiredextraction_evaluation
requiredautomation_rules
requiredextracted_pages_limit
number · required
name
string | null
QueueEligibleApproverDto
id
string · uuid · requiredname
string · required
QueueEligibleApproversResponseDto
data
object[] · required
QueueExcludeFields
QueueFeatureRequest
enabled
boolean · required
QueueFeatureResponse
enabled
boolean · required
QueueFeatureStatusEnum
QueueFeaturesDto
extraction
requiredapproval
requiredrelearning
requiredisdoc_extraction
requiredinvalid_invoice_detection
requiredbounce_email
requiredai_template_matching
requiredai_line_items_template_matching
requiredai_automated_accounting
requiredadvanced_approval
requiredadvanced_approval_auto_export
requiredaudit_log
requiredqueue_schema_per_user
requiredsplit_document_by_qr_code
required
QueueIncludeFields
QueueResponseDto
data
object · required
QueueSchemaContext
QueueSettingsDto
annotation_schema_columns
object[] · requiredpossible_schema_columns
object[] · requireduser_schema_columns
object[] · required
QueueSettingsResponseDto
data
object · required
QueueTypeEnum
QueueUserDto
id
string · uuid · requiredname
string | null · requiredemail
string · requiredstatus
required
QueueUsersResponseDto
data
object[] · required
QueueWithAnnotationSchemaDto
id
string · uuid · requiredhumanized_id
number · requiredcreated_at
string · date-time · requiredA datetime in ISO8601 with time zone
type
requiredcurrency
string · requiredworkspace_id
string · uuid · requiredinbox_hash
string · requiredinbox_hash_prefix
string · requiredExample: main-workspace.received-invoicesinbox
string · requiredextraction_evaluation
requiredautomation_rules
requiredextracted_pages_limit
number · required
name
string | nullannotation_schema
object[]An annotation schema
access_actions
string[]Enum values:readupdatedeleteupload-documentupdate-documentupdate-document-stagelock-documentvalidate-annotationsdocuments_to_process_count
numbersettings
Queue settings
features
| nulldocuments_count
Queue documents counts
workspace
Workspace metadata
extraction_evaluation_rule
| nullvalidations_settings
object
QueuesApiResponse
data
object[] · requiredA list of queues
pagination
object · required
QueuesResponseDto
data
object[] · required
RangeFilterApiResponse
data
object · required
RangeFilterField
min
number | null · requiredmax
number | null · required
RawAnnotationValueDto
index
number · requiredregion
object · required
value
| nullraw_value
string
ReExtractionEnum
RefreshTokenRequestDto
refresh_token
string · required
RegionDto
left
number · requiredtop
number · requiredwidth
number · requiredheight
number · requiredpage
number · min: 1 · required
RegisterChangeDto
type
string · required
RegisterDto
id
string · uuid · requiredtype
string · required
RegisterInternalDto
id
string · uuid · requiredtype
string · required
internal
booleanhide_register_value
boolean
RegisterItemDto
value
string | null · requiredlabel
string · requiredshown_label
string · required
RegisterOptionDto
label
string · requiredA label that will be shown in an UI
value
string · requiredA value that will be set when a user chooses this option
alias
string | nullA value that will be used to check for historical data when values change
RegisterUploadMethod
RegistersApiResponse
data
object[] · requiredpagination
object · required
RegistersInternalResponseDto
data
object[] · required
RemoveBasicAnnotationInputDto
field
string · requiredAnnotation field to be updated
index
numberZero based index of the annotation value of a field. Mostly used for multivalue fields.
ReportDateAggInterval
ReportTimeSpentFiltersDto
annotations_source
| null
ResetPasswordRequestDto
email
string · email · required
RowValidationMessageDto
table_key
string · requiredrow_index
number · requiredmessage
| null · required
ScheduledTaskDto
affected
number · requirednot_affected
number · requiredid
string · uuid · requiredstatus
required
ScheduledTaskResponseDto
data
object · required
ScheduledTaskStatus
SchemaFieldVisibility
SectionVisibilityEnum
SepaPaymentDialogAlphanumericDataType
value
string | null · requirederrors
string[] · requiredEnum values:missing_fieldmissing_valueinvalid_ibaninvalid_biccountry_mismatch_iban_bicunable_to_pay_negative_amountunable_to_pay_zero_amountalready_paidvalidation_errors
object[] · required
SepaPaymentDialogNumericDataType
value
string | null · requirednumeric_value
number | null · requirederrors
string[] · requiredEnum values:missing_fieldmissing_valueinvalid_ibaninvalid_biccountry_mismatch_iban_bicunable_to_pay_negative_amountunable_to_pay_zero_amountalready_paidvalidation_errors
object[] · required
SepaPaymentItemData
sender_name
object · requirediban
object · requiredbic
object · requiredvar_sym
object · requiredcurrency
object · requiredtotal_due
object · required
SepaPaymentItemError
ServiceAccountTokenDto
access_token
string · required
ServiceAccountTokenResponseDto
data
object · required
SetOrderAutomationRulesBodyDto
ids
string[] · required
SetOrderAutomationRulesResponseDto
data
object[] · required
SetSchemaFieldVisibilityDto
field_key
string · requiredhidden
boolean · required
SetSchemaVisibilityResponseDto
data
object[] · requiredAn annotation schema
SortDirection
SortQuery
field
string · requiredEither the key of the annotation field or one of the key of sortable document metadata (file_name, internal_erp_id, last_status_change_at, last_status_change_by, marked_as_exported_at, marked_as_ready_to_export_at, source, payment_status, page_count, created_at, received_from, email_subject, last_modified_name, last_modified_date, workspace_name, queue_name)
direction
required
SseDocumentExtractedPayloadDto
document_id
string · uuid · required
StageAggregationData
stage
requiredduration
number · required
StatusChangeCountsAggregatedDto
date
string · date-time · requiredcount
number · requiredusers
object[] · required
StatusHistoryCountsPerQueueDto
queue_id
string · uuid · requiredqueue_name
string · requiredqueue_humanized_id
number · requiredunresolved
number · requiredsent
number · requiredskipped
number · requireddeleted
number · requiredusers
object[] · required
StatusHistoryCountsPerWorkspaceDto
workspace_id
string · requiredworkspace_name
string · requiredworkspace_humanized_id
number · requiredunresolved
number · requiredsent
number · requiredskipped
number · requireddeleted
number · requiredqueues
object[] · required
StringBoolean
StripeLineItem
price
string · required
quantity
number
StripeRangeParamsDto
gt
numbergte
numberlt
numberlte
number
TableAnnotationChangeDto
table_key
string · requiredfield
string · requiredrow_index
number · requiredindex
number · requiredvalues
requiredList of changed annotations
TaxDetailDataResponse
tax_detail
object[] · required
TaxDetailResponseDto
data
object · requiredpagination
object · required
ThirdPartyValidationSettingsDto
key
requiredstatus
required
params
object
TimeSpentPerDocumentAggregationDto
queue_id
string · uuid · requiredqueue_name
string · requiredqueue_humanized_id
number · requiredworkspace_id
string · requiredworkspace_name
string · requiredworkspace_humanized_id
number · requireddocument_id
string · uuid · requireddocument_page_count
number · requiredduration
number · required
TimeSpentPerQueueAggregationDto
queue_id
string · uuid · requiredqueue_name
string · requiredqueue_humanized_id
number · requiredduration
number · required
TimeSpentPerSessionAggregationDto
queue_id
string · uuid · requiredqueue_name
string · requiredqueue_humanized_id
number · requiredworkspace_id
string · requiredworkspace_name
string · requiredworkspace_humanized_id
number · requireduser_id
string · uuid · requireduser_name
string | null · requireduser_email
string · requireddocument_id
string · uuid · requireddocument_page_count
number · requiredstart
string · date-time · requiredend
string · date-time · requiredstage
requiredduration
number · required
TimeSpentPerUserAggregationDto
user_id
string · uuid · requireduser_name
string | null · requireduser_email
string · requiredduration
number · required
TimeSpentPerWorkspaceAggregationDto
workspace_id
string · requiredworkspace_name
string · requiredworkspace_humanized_id
number · requiredduration
number · requiredqueues
object[] · required
TokenResponseDto
access_token
string · requiredJWT access token
refresh_token
string · requiredJWT refresh token
expires_at
string · date-time · requiredrefresh_token_expires_at
string · date-time · required
UILocale
UpdateAnnotationAuxDto
annotation_changes
object | null · requiredAn object of annotations changes
Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}]}register_changes
object[] · requiredglobal_status
| null · requiredAnnotations global status
UpdateAnnotationGlobalStatusDto
global_status
object · required
UpdateAnnotationGlobalStatusResponseDto
data
object · required
UpdateAnnotationResponseDto
data
object · required
UpdateAnnotationSchemaDto
annotation_schema
object[] · minItems: 1 · requiredExample: [{"type":"subtitle","message":"Hlavní sekce","sectionMessageKey":"payment_details"},{"type":"field","key":"sender_name","message":"Sender Name","datatype":"alphanumeric","hidden":false,"autofill":["sender_tax_id"]},{"type":"separator","separatorKey":"separator-1"},{"type":"field","key":"tax_detail","subfields":[{"key":"rate","datatype":"numeric"}]},{"type":"separator","separatorKey":"separator-2"},{"type":"field","key":"line_items","subfields":[{"key":"description","datatype":"alphanumeric","defaultValue":"Hello"}]}]
UpdateBasicAnnotationInputDto
field
string · requiredAnnotation field to be updated
value
requiredAnnotation value object to be set
index
numberZero based index of the annotation value of a field. Mostly used for multivalue fields.
UpdateTableAnnotationAuxDto
annotation_changes
object[] · requiredregister_changes
object[] · requiredglobal_status
| null · requiredAnnotations global status
updated_totals
object[] · required
row_validation_messages
array | null
UpdateTableAnnotationInputDto
field
string · requiredAnnotation field to be updated
table_key
requiredAnnotation table to be updated
row_index
number · requiredAnnotation table row index (0-based) to be updated
value
requiredAnnotation value object to be set
index
numberZero based index of the annotation value of a field. Mostly used for multivalue fields.
UpdateTableAnnotationResponseDto
data
object · required
UpdateWebhookDto
url
string · url · requiredURL must be a valid HTTP URL
signature_verification
| null
UploadDocumentEmailDataDto
subject
string · requiredbody-html
string · requiredsender
string · required
body-plain
string | null
UploadQueueRegistersDto
registers
object[] · minItems: 1 · requiredmethod
requiredqueue_id
string · uuid · required
UploadRegisterRequest
type
string · requiredoptions
object[] · required
UploadedFilesResponse
document_ids
string[] · required
UpsertUserReportSettingsBodyDto
data
object · required
UserAggregationDataDto
user_id
string · uuid · requireduser_name
string | null · requireduser_email
string · requiredduration
number · requireddata
object[] · required
UserApprovalStatus
UserApprovalStatusDto
status
required
UserApprovalStatusResponseDto
data
object · required
UserDto
id
string · uuid · requiredui_locale
requiredname
string | null · requiredemail
string · email · requiredstatus
requiredcreated_at
string · date-time · required
UserNotificationDto
id
string · uuid · requiredtype
requiredstatus
requiredaction_link
string | null · requiredmessage
string · requiredcreated_at
string · date-time · required
UserNotificationsResponseDto
data
object[] · requiredarray of response data
pagination
requiredpagination
UserOnboardingStatus
UserOtpResponseDto
data
object · required
UserOtpSettingsDto
otp_secret
string | null · requiredotp_uri
string | null · requiredotp_status
requiredotp_last_verification_date
string | null · required
UserReportSettingsDto
user_id
string · uuid · requiredorganization_id
string · uuid · requiredcreated_at
string · date-time · requiredupdated_at
string · date-time · requireddata
object · required
UserReportSettingsResponseDto
data
| null · required
UserResponseDto
data
object · required
UserRoleInQueueDto
id
string · uuid · requiredqueue
object · required
role
membership_id
string · uuid
UserRoleInWorkspaceDto
id
string · uuid · requiredqueues
object[] · requiredworkspace
object · required
role
| nullmembership_id
string · uuid
UserRolesInWorkspaceQueues
workspace_id
string | null · uuid · requiredqueues
object[] · required
UserRolesInWorkspacesAndQueuesDto
workspaces
object[] · required
UserRolesInWorkspacesAndQueuesResponseDto
data
object · required
UserStatus
UserStatusChangeBreakdownDto
status
requiredcount
number · required
UserStatusChangeDto
user_id
string · uuid · requireduser_name
string | null · requireduser_email
string · requiredcount
number · requiredstatuses
object[] · required
UserStatusHistoryDto
user_id
string · uuid · requireduser_name
string | null · requireduser_email
string · requiredunresolved
number · requiredsent
number · requiredskipped
number · requireddeleted
number · required
UserTypeEnum
UserWithDefaultOrganization
id
string · uuid · requiredui_locale
requiredname
string | null · requiredemail
string · email · requiredstatus
requiredotp_status
requiredonboarding_status
requiredcreated_at
string · date-time · requiredorganization_id
string | null · uuid · requiredworkspace_id
string | null · uuid · requiredqueue_id
string | null · uuid · requiredorganization_humanized_id
number | null · requiredworkspace_humanized_id
number | null · requiredqueue_humanized_id
number | null · requiredapproval_dashboard
boolean | null · requiredhighest_roles
object[] · requirednotification_settings
object · requiredfeature_flags
object · requiredinternal_tester
boolean · required
UserWithDefaultOrganizationResponseDto
data
object · required
ValidatedAnnotationsDto
annotations
object · 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}]}]}global_status
| null · requiredAnnotations global status
ValidatedAnnotationsResponseDto
data
object · required
ValidationKey
ValidationMessageKey
ValidationResultDto
message
string | null · requiredmessage_key
requiredseverity
required
autofilled_from
stringvalidation_key
| nullvalidation_timestamp
number | null
ValidationSettingStatus
ValueFilterApiResponse
data
object[] · required
ValueFilterField
key
string · required
label
string | null
VerifyOtpDto
otp
string · required
WebhookApiResponseDto
data
object · required
WebhookEntityTypeEnum
WebhookResponseDto
id
string · uuid · requiredentity_id
string · uuid · requiredentity_type
requiredurl
string · url · requiredURL must be a valid HTTP URL
signature_verification
requiredtype
required
WebhookSignatureVerification
WebhookSigningKeyDto
webhook_signing_key
string · required
WebhookSigningKeyResponseDto
data
object · required
WebhookType
WebhooksApiResponseDto
data
object[] · required
WorkspaceDto
id
string · uuid · requiredhumanized_id
number · requiredname
string · requiredregister_id
string | null · requiredtax_id
string | null · requiredvat_id
string | null · requiredorganization_id
string · uuid · requiredordering
number · requiredglobal_error
string | null · requiredglobal_error_description
string | null · requiredintegration_id
string · uuid · requiredicon_color
string · requiredtype
required
access_actions
string[]Enum values:readupdatedeleteupload-documentupdate-documentupdate-document-stagelock-documentvalidate-annotationsdocuments_to_process_count
numberqueues
object[]
WorkspaceIncludeFields
WorkspaceOrderBy
WorkspaceOrderDirection
WorkspaceRegion
WorkspaceResponseDto
data
object · required
WorkspaceType
WorkspaceWithTokenDto
id
string · uuid · requiredhumanized_id
number · requiredname
string · requiredregister_id
string | null · requiredtax_id
string | null · requiredvat_id
string | null · requiredorganization_id
string · uuid · requiredordering
number · requiredglobal_error
string | null · requiredglobal_error_description
string | null · requiredintegration_id
string · uuid · requiredicon_color
string · requiredtype
requiredtoken
string · required
access_actions
string[]Enum values:readupdatedeleteupload-documentupdate-documentupdate-document-stagelock-documentvalidate-annotationsdocuments_to_process_count
numberqueues
object[]
WorkspaceWithTokenResponseDto
data
object · required
WorkspacesResponseDto
data
object[] · requiredarray of response data
pagination
requiredpagination