Documentation | Digitoo.ai

AboPaymentDialogAlphanumericDataType

valuestring | null · required
errorsstring[] · required
Enum values:
missing_value
invalid_bank_account
unable_to_pay_negative_amount
unable_to_pay_zero_amount
already_paid
invalid_currency
validation_errorsobject[] · required

AboPaymentDialogNumericDataType

valuestring | null · required
numeric_valuenumber | null · required
errorsstring[] · required
Enum values:
missing_value
invalid_bank_account
unable_to_pay_negative_amount
unable_to_pay_zero_amount
already_paid
invalid_currency
validation_errorsobject[] · required

AboPaymentFileType

string · enum

Enum values:

ALL

KPC

PDF

AboPaymentItemData

sender_nameobject · required
var_symobject · required
total_dueobject · required
account_numberobject · required
currencyobject · required

AboPaymentItemError

string · enum

Enum values:

missing_value

invalid_bank_account

unable_to_pay_negative_amount

unable_to_pay_zero_amount

already_paid

invalid_currency

AboPaymentSPD

valuestring | null
errorstring | null

AcceptableSettingsKeys

string · enum

Enum values:

accounting_confidence_check

adis_bank_check

adis_reliable_payer

vies

ares

AccountAutomationAnnotation

fieldstring · required
valuestring · required

AccountAutomationAnnotationWithMetadata

fieldstring · required
valuestring · required
labelstring | null · required

AccountingAutomationDto

conditionsobject · required
idstring · uuid · required
namestring | null · required
queue_idstring · uuid · required
created_atstring · date-time · required
updated_atstring · date-time · required
actionrequired
action_paramsobject · required

validation_result | null

AccountingAutomationListResponseDto

dataobject[] · required

AccountingAutomationResponseDto

dataobject · required

AccountingAutomationRule

string · enum

Enum values:

enabled

disabled

AccountingAutomationRuleAction

string · enum

Enum values:

apply_accounting_automation

AccountingAutomationRuleParams

annotationsobject[] · required

AccountingAutomationRuleParamsWithMetadata

annotationsobject[] · required

AccountingAutomationRules

string · enum

Enum values:

enabled

disabled

AccountingConfidenceFieldSettingDto

keystring · required

warning_threshold | null

AccountingConfidenceThreshold

string · enum

Enum values:

DISABLED

100

90

80

70

60

50

AccountingConfidenceValidationParamsDto

warning_threshold | null
fieldsobject[]

AccountingSystemDto

namerequired

credentialsstring | null

AccountingSystemEnum

string · enum

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

AddUserRoleInQueueDto

idstring · uuid · required
rolerequired

AdvancedApprovalFeatureEnum

string · enum

Enum values:

enabled

disabled

Document approval status

AdvancedApprovalStatusEnum

string · enum

Enum values:

undetermined

initiated

pending

approved

declined

Document global approval status

AffectedEntitiesCountDto

affectednumber · required
not_affectednumber · required

AffectedEntitiesCountResponseDto

dataobject · required

AmountAggregateDto

sumnumber · required
avgnumber · required
minnumber · required
maxnumber · required

AmountAggregatesDto

currencystring · required
aggregatesobject · required
countnumber · required

AmountAggregatesResponseDto

dataobject[] · required

AnnotationCommentDto

idstring · uuid · required
region | null · required
document_idstring · uuid · required
created_by_idstring · uuid · required
contentobject[] · required
created_atstring · date-time · required
updated_atstring · date-time · required
deleted_atstring | null · required
parent_idstring | null · uuid · required

AnnotationCommentResponseDto

dataobject · required

AnnotationCommentThreadDto

idstring · uuid · required
region | null · required
document_idstring · uuid · required
created_by_idstring · uuid · required
contentobject[] · required
created_atstring · date-time · required
updated_atstring · date-time · required
deleted_atstring | null · required
repliesobject[] · required

AnnotationCommentThreadsResponseDto

dataobject[] · required

AnnotationDateValueDto

valuestring | null
labelstring | null
usage_counternumber | null
region | null
raw_annotation_indicesarray | null
validation_result | null
validation_resultsarray | null
direct_user_inputboolean | null
probabilitynumber | null
iso_date_valuestring | null

AnnotationFieldDto

fieldstring · required
valuesrequired

AnnotationFieldRenderOptionDto

valuestring | null · required
labelstring · required

label_keystring | null

AnnotationFieldRenderTypeEnum

string · enum

Enum values:

field

subtitle

separator

approval

AnnotationGlobalMessageDto

validation_result | null · required
fieldstring | null · required
subfieldstring | null · required
field_messagestring | null · required
subfield_messagestring | null · required
field_message_keystring | null · required
subfield_message_keystring | null · required

AnnotationGlobalStatusResponseDto

dataobject · required

AnnotationNumericSuggestionDto

valuestring · required
numeric_valuenumber · required

AnnotationNumericValueDto

valuestring | null
labelstring | null
usage_counternumber | null
region | null
raw_annotation_indicesarray | null
validation_result | null
validation_resultsarray | null
direct_user_inputboolean | null
probabilitynumber | null
numeric_valuenumber
suggestionsobject[]

AnnotationSchemaColumnsDto

messagestring · required
keystring · required
datatyperequired
visibilityrequired
widthnumber | null · required

AnnotationSchemaDto

typerequired

messagestring
Label for entity field shown in Digitoo App UI. key will be used if not provided. Mandatory only for subtitle type item.
message_keystring
Message key translation for entity field shown in Digitoo App UI. key will be used if not provided.
keystring
Entity 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 | null
Default value to apply if no value extracted by engine.
hiddenboolean
Whether an entity field should be initially hidden in UI. false will be used if not provided.
Default: false
hide_register_valueboolean
Whether an register item should have visible value in Digitoo App UI. false will be used if not provided.
Default: false
requiredboolean
whether an entity field should be required to have value before exporting. false will be used if not provided.
Default:
autofillstring[]
List of entities to initiate value from engine extracted values. Does not yet work for table entity subfields.
subfieldsobject[]
List of entities for table entities (currently only line_items and tax_detail are supported).
multivalueboolean
Whether an entity field should be rendered as multivalue.
Default: false
section_message_key
Adds sectionMessageKey in order to sort on
separator_keystring | null
Adds separatorKey in order to sort on
multilineboolean | null
pattern_matching | null
updated_by_userboolean | null
Whether schema field has been changed in Digitoo App UI.
formatting | null
Whether schema field should be formatted by Digitoo App UI during selection.
max_lengthnumber

AnnotationSchemaFieldDataTypeEnum

string · enum

Enum values:

numeric

date

alphanumeric

register

Entity datatype. Mandatory only for field type item.

AnnotationSchemaFilterableFieldType

string · enum

Enum values:

numeric

date

value

Type of returned filter

AnnotationSchemaNumericType

string · enum

Enum values:

int

float

amount

Numeric type for numeric fields.

AnnotationSchemaResponse

annotation_schemaobject[] · required
An annotation schema

AnnotationSchemaSectionMessageKey

string · enum

Enum values:

ekonom_basic_invoice_data

ekonom_supplier_details

ekonom_recipient_details

ekonom_header_registers

pohoda_basic_invoice_data

pohoda_supplier_details

pohoda_recipient_details

pohoda_header_registers

Adds sectionMessageKey in order to sort on

AnnotationSchemaSubfieldsDto

keystring · required
Entity identifier. Mandatory only for field type item.

datatype | null
Entity datatype. Mandatory only for field type item.
messagestring
Label for entity field shown in Digitoo App UI. key will be used if not provided. Mandatory only for subtitle type item.
hiddenboolean
Whether an entity field should be initially hidden in UI. false will be used if not provided.
Default: false
requiredboolean
whether an entity field should be required to have value before exporting. false will be used if not provided.
Default:
default_value | null
Default value to apply if no value extracted by engine.
hide_register_valueboolean | null
Whether an register item should have visible value in Digitoo App UI. false will be used if not provided.
Default: false
pattern_matching | null
updated_by_userboolean | null
Whether schema field has been changed in Digitoo App UI.
formatting | null
Whether schema field should be formatted by Digitoo App UI during selection.

AnnotationSourceEnum

string · enum

Enum values:

ai

edi

none

Document source

AnnotationSourceType

string · enum

Enum values:

isdoc

eKasa

AnnotationTableField

string · enum

Enum values:

line_items

tax_detail

Annotation table to be updated

AnnotationTableRowDto

valuesobject[] · required
validation_resultsobject[] · required
validation_result | null · required

AnnotationTableValueTotalDto

fieldstring · required
totalnumber · required

AnnotationValidationMessageSeverityEnum

string · enum

Enum values:

seenByHuman

info

warning

error

AnnotationValueDto

valuestring | null
labelstring | null
usage_counternumber | null
region | null
raw_annotation_indicesarray | null
validation_result | null
validation_resultsarray | null
direct_user_inputboolean | null
probabilitynumber | null

AnnotationValueInput

valuestring | null · required
Annotation value string to be set

region | null
Position of annotation in document
raw_annotation_indicesarray | null
Array of annotation indices

AnnotationsFormattingEnum

string · enum

Enum values:

regular

simplified

AnnotationsGlobalStatusDto

export_allowedboolean · required
approve_allowedboolean · required
annotations_edit_allowedboolean · required
skip_allowedboolean · required
deletion_allowedboolean · required
initiate_approval_allowedboolean · required
move_allowedboolean · required
rejection_allowedboolean · required
message | null · required

ApprovalAutomationDto

conditionsobject · required
idstring · uuid · required
namestring | null · required
queue_idstring · uuid · required
created_atstring · date-time · required
updated_atstring · date-time · required
actionrequired
action_params | null · required

validation_result | null

ApprovalAutomationListResponseDto

dataobject[] · required

ApprovalAutomationMatchDto

conditionsobject · required
idstring · uuid · required
namestring | null · required
queue_idstring · uuid · required
created_atstring · date-time · required
updated_atstring · date-time · required
actionrequired
action_params | null · required

validation_result | null
approval_processarray | null

ApprovalAutomationMatchResponseDto

data | null · required

ApprovalAutomationResponseDto

dataobject · required

ApprovalDocumentCountsData

to_approvenumber · required
returns count of documents which could be approved by current user
approvednumber · required
returns count of documents which had been approved by current user
rejectednumber · required
returns count of documents which had been rejected
sentnumber · required
returns count of documents which had been approved and sent to ERP
allnumber · required
returns count of documents which had been approved by current user and has stage 'ALL'

ApprovalDocumentCountsResponseDto

datarequired
response data

ApprovalGroupCreateBodyDto

namestring · required
itemsobject[] · minItems: 1 · required

ApprovalGroupDto

idstring · uuid · required
namestring · required
queue_idstring · uuid · required
itemsobject[] · required
created_atstring · date-time · required
updated_atstring · date-time · required
deleted_atstring | null · required

ApprovalGroupItemDto

user_idstring · uuid · required

ApprovalGroupPutBodyDto

namestring · required
itemsobject[] · minItems: 1 · required

ApprovalGroupResponseDto

dataobject · required

ApprovalGroupsResponseDto

dataobject[] · required

ApprovalOrder

string · enum

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

Document approval order

ApprovalProcessGroupItemDto

approval_group_idstring · uuid · required
approval_group_namestring · required
approval_group_policyrequired
statusrequired
itemsobject[] · required

ApprovalProcessUserItemDto

user_idstring · uuid · required
namestring · required
statusrequired
messagestring | null · required

ApprovalRouteDto

idstring · uuid · required
orderrequired
namestring | null · required
name_with_usersstring · required
Example: Scenario (John Doe, ... +3)
queue_idstring · uuid · required
usersobject[] · required
itemsarray · required

ApprovalRouteGroupDto

approval_group_idstring · uuid · required
approval_group_namestring · required
approval_group_policyrequired
itemsobject[] · required

ApprovalRouteGroupPolicy

string · enum

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

ApprovalRouteResponseDto

dataobject · required

ApprovalRouteType

string · enum

Enum values:

TEMPLATE

MANUAL

ApprovalRouteUserDto

user_idstring · uuid · required
user_emailstring · email · required
user_namestring · required
Example: John Doe

ApprovalRoutesResponseDto

dataobject[] · required

ApprovalStatusData

approval_enabledboolean · required
true if at least one queue has enabled approval
documents_to_approve_countnumber · required
count of documents to approve

ApprovalStatusEnum

string · enum

Enum values:

approved

declined

pending

undetermined

initiated

restarted

send_back

ApprovalStatusResponseDto

datarequired
response data

AttachmentDto

idstring · uuid · required
created_atstring · date-time · required
A datetime in ISO8601 with time zone
file_pathstring · required
file_namestring · required
mime_typestring · required
file_sizenumber · required
file_size_human_readablestring · required
urlstring · required

AttachmentLinkBodyDto

entity_idstring · uuid · required
entity_typerequired

AutomationAssignApprovalRouteParams

approval_route_idstring · uuid · required

AutomationAssignApproversParams

approversstring[] · required
Example: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]

AutomationBinaryArrayConditionBaseDto

operationrequired
variablestring · required
valuesstring[] · required

validation_result | null

AutomationBinaryArrayConditionDto

operationrequired
variablestring · required
valuesstring[] · required
labelsstring[] · required

validation_result | null

AutomationBinaryConditionDto

operationrequired
variablestring · required
valuerequired
labelstring | null · required

validation_result | null

AutomationBinaryConditionEmailDto

operationrequired
variablestring · required
valuestring · email · required
labelstring | null · required

AutomationBinaryConditionEmailRawDto

operationrequired
variablestring · required
valuestring · email · required

AutomationBinaryConditionRawDto

operationrequired
variablestring · required
valuerequired

validation_result | null

AutomationBinaryConditionUUIDDto

operationrequired
variablestring · required
valuestring · uuid · required
labelstring | null · required

AutomationBinaryConditionUUIDRawDto

operationrequired
variablestring · required
valuestring · uuid · required

AutomationConditionsDto

operationrequired
conditionsarray · required

AutomationConditionsRawDto

operationrequired
conditionsarray · required

AutomationNestedConditionDto

operationrequired
conditionsarray · required

validation_result | null

AutomationNestedConditionRawDto

operationrequired
conditionsarray · required

validation_result | null

AutomationRuleAction

string · enum

Enum values:

assign_approval_route

assign_approvers

move_to_next_stage

AutomationRuleValidationResult

message_keystring · required

AutomationRules

string · enum

Enum values:

enabled

disabled

AutomationSupportedBinaryArrayOperation

string · enum

Enum values:

in

AutomationSupportedBinaryOperation

string · enum

Enum values:

in

===

>

<

>=

<=

date_after

date_before

AutomationSupportedNestedOperation

string · enum

Enum values:

and

or

!

AutomationSupportedOperation

string · enum

Enum values:

and

or

!

!!

===

in

>

<

AutomationSupportedUnaryOperation

string · enum

Enum values:

!

!!

AutomationUnaryConditionBaseDto

operationrequired
variablestring · required

validation_result | null

AutomationUnaryConditionDto

operationrequired
variablestring · required

validation_result | null

BankAccountResponseDto

currencyrequired
Example: CZK
idstring · uuid · required
namestring | null · minLength: 1 · maxLength: 16 · required
account_numberstring · required
ibanstring | null · required
swiftstring | null · required

BillableFeatureDto

statusrequired

BillableFeaturesDto

commentsobject · required
inboxobject · required
audit_logobject · required
statisticsobject · required
automationobject · required
accounting_automationobject · required
ediobject · required
ai_accountingobject · required
template_matchingobject · required
adisobject · required
aresobject · required
viesobject · required

BillableFeaturesStatusEnum

string · enum

Enum values:

enabled

disabled

BillableSupportDto

premium_supportobject · required
standard_supportobject · required

BillingCredits

allocationnumber · required
availablenumber · required

BillingFeatureDto

idstring · required
namestring · required
keystring · required
activeboolean · required
ordernumber · required
pricesobject · required
available_in_tiersstring[] · required

BillingIntegrationDto

idstring · required
namestring · required
keystring · required
pricesobject · required

BillingSessionCheckout

checkout_urlstring | null · url · required
URL must be a valid HTTP URL. Does not require a TLD and must have a protocol
success_urlstring | null · url · required
URL must be a valid HTTP URL. Does not require a TLD and must have a protocol
cancel_urlstring | null · url · required
URL must be a valid HTTP URL. Does not require a TLD and must have a protocol

BillingSessionCheckoutResponse

dataobject · required

BillingUser

idstring · required
namestring · required
keystring · required
pricesobject · required
available_in_tiersstring[] · required

BillingVerification

statusstring · required
total_paidnumber | null · required

BillingVerificationResponse

dataobject · required

BillingWorkspace

idstring · required
namestring · required
keystring · required
pricesobject · required
available_in_tiersstring[] · required

BulkApproveDocumentsDto

filtersobject · required
queue_idstring · uuid · required

searchstring | null
messagestring | null

BulkApproveOrganizationDocumentsDto

filtersobject · required
organization_idsstring[] · required
Example: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]

searchstring | null
messagestring | null

BulkInitiateApprovalDocumentsDto

filtersobject · required
queue_idstring · uuid · required

notify_current_approvers | null
Should be current approvers notified. Default is to notify.
Default: notify
searchstring | null

BulkInitiateApprovalOrganizationDocumentsDto

filtersobject · required
organization_idsstring[] · required
Example: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]

notify_current_approvers | null
Should be current approvers notified. Default is to notify.
Default: notify
searchstring | null

BulkPurgeDocumentsDto

filtersobject · required
queue_idstring · uuid · required

searchstring | null

BulkRejectDocumentsDto

filtersobject · required
queue_idstring · uuid · required
rejection_reasonstring · required

searchstring | null
reject_documentboolean | null

BulkRejectOrganizationDocumentsDto

filtersobject · required
organization_idsstring[] · required
Example: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]
rejection_reasonstring · required

searchstring | null
reject_documentboolean | null

ChangePasswordRequestDto

tokenstring · required
Token used to request password change
passwordstring · required

ChangePasswordResponseDto

dataobject · required

ContactIntegrationPartnerDto

emailstring · required
phonestring · required
integration_idstring · uuid · required
organization_idstring · uuid · required

messagestring | null

ContractPeriod

string · enum

Enum values:

monthly

yearly

biyearly

CreateBankAccountDto

currencyrequired
workspace_idstring · uuid · required
namestring · minLength: 1 · maxLength: 16 · required
account_numberstring · required
ibanstring | null · required
swiftstring | null · required

CreateBankAccountResponseDto

dataobject · required

CreateOrganizationDto

namestring · required
Organization name

CreateQueueDto

typerequired
namestring | null · minLength: 1 · required
A name of a queue
localerequired
currencystring · minLength: 1 · required
Currency assigned to the queue (ISO code)

approvalboolean | null
Whether to use approval flow
Default: false
extractionboolean | null
Whether to allow extraction of documents
Default: true

CreateQueuesDto

queuesobject[] · required

CreateScheduledTaskDto

export_typerequired

sortobject
searchstring | null
export_file_name_optionsstring[]
Enum values:
sender_name
sender_register_id
invoice_id
internal_erp_id
original_filename
export_optionsobject
filtersobject
export_entitiesstring[]
Enum values:
attachments
documents
audit_logs

CreateUserRequest

emailstring · email · required
phonestring · required
User phone
ui_localerequired

companystring | null
register_idstring | null
vat_idstring | null
erpstring | null
invoice_countnumber

CreateWebhookDto

urlstring · url · required
URL must be a valid HTTP URL
entity_typerequired
entity_idstring · uuid · required

type | null
Default: document_status_changed
signature_verification | null

CreateWorkspaceDto

namestring · required
regionrequired
organization_idstring · uuid · required
accounting_systemobject · required
queue_optionsobject[] · required

company_id_numberstring
A valid company ID number
tax_idstring
vat_idstring
integration_idstring | null · uuid

CurrencyCode

string · enum

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

CustomWorkspaceSortItem

workspace_idstring · uuid · required
queuesstring[] · required

DashboardPaginationDto

next_documentstring | null · uuid · required
previous_documentstring | null · uuid · required
positionnumber · required
total_countnumber · required

DashboardPaginationResponseDto

dataobject · required

Data

connection_statusrequired

DateAggregationDataDto

datestring · date-time · required
durationnumber · required
dataobject[] · required

DeleteDocumentRegistersDto

registersobject[] · required

DeleteQueueRegistersDto

registersobject[] · required
queue_idstring · uuid · required

DeleteRegisterOption

valuestring · required

DeleteRegisterRequest

typestring · required
optionsobject[] · required

DeltaOpDto

insertrequired

attributesobject

DeltaOpInsertObjectDto

mention | null

DeltaOpMentionUserDto

indexstring · required
denotation_charstring · required
valuestring · required
idstring · uuid · required
typestring · enum · required
Enum values:
user

DemoInitializeBodyDto

localerequired
emailstring · email · required
phonestring · required
companystring | null · required
register_idstring | null · required
vat_idstring | null · required

DemoInitializeResponseDataDto

magic_linkstring · url · required
URL must be a valid HTTP URL. Does not require a TLD and must have a protocol

DemoInitializeResponseDto

dataobject · required

DocumentAggregationDataDto

queue_idstring · uuid · required
queue_namestring · required
queue_humanized_idnumber · required
workspace_idstring · required
workspace_namestring · required
workspace_humanized_idnumber · required
document_idstring · uuid · required
document_page_countnumber · required
durationnumber · required
dataobject[] · required

DocumentAnnotationsDto

dataobject · 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}]}]}

DocumentApprovalDto

idstring · uuid · required
approval_route_idstring | null · uuid · required
approval_route_type | null · required
approval_featurerequired
approval_processarray · required
approval_statusrequired
route_namestring | null · required
approval_route_orderrequired

DocumentApprovalResponseDto

dataobject · required

DocumentApprovalRouteDto

orderrequired
usersobject[] · required
itemsarray · required

DocumentApprovalRouteResponseDto

dataobject · required

DocumentAuditLogDto

idnumber · required
created_atstring · date-time · required
document_idstring · uuid · required
eventrequired
Document event
new_valuestring | null · required
previous_valuestring | null · required
user_idstring · uuid · required
user_namestring · required
metadata | null · required

DocumentAuditLogEvent

string · enum

Enum values:

document_import

document_import_via_email

document_moved

document_metadata_create

document_metadata_update

document_metadata_delete

annotation_create

annotation_update

Document event

DocumentAuditLogHumanizedDocumentDto

imported_atstring · date-time · required
imported_via_emailboolean · required
filenamestring · required

sender_addressstring | null

DocumentAuditLogHumanizedItemDto

datestring · date-time · required
operationrequired
textstring · required
user_idstring · uuid · required

DocumentAuditLogHumanizedOperation

string · enum

Enum values:

update

add

delete

approval_restart

DocumentAuditLogHumanizedResponseDto

dataobject[] · required
array of response data
paginationrequired
pagination
documentobject · required

DocumentAuditLogMetadataDto

field_messagestring | null
row_indexnumber
tablestring | null

DocumentAuditLogResponseDto

dataobject[] · required
array of response data
paginationrequired
pagination

DocumentByPaymentStatusAggregatorResultDto

unpaidnumber · required
paidnumber · required
to_paynumber · required
payment_ordernumber · required
past_duenumber · required

DocumentByStageAggregatorResultDto

to_approvenumber · required
to_validationnumber · required
laternumber · required
sentnumber · required
deletednumber · required
rejectednumber · required
spamnumber · required
totalnumber · required

DocumentDuplicityDto

idstring · uuid · required
stagerequired
statusrequired
sourcerequired
last_status_changed_atstring | null · date-time · required
Date of last status change
document_urlstring · required
Document url

DocumentEditsDto

pagesobject[] · minItems: 1 · required

DocumentExportQueryDto

typerequired
File export type

export_columns_options | null
export_file_name_optionsstring[]
Enum values:
sender_name
sender_register_id
invoice_id
internal_erp_id
original_filename
export_line_items | null

DocumentInboxStatus

string · enum

Enum values:

sorted

unsorted

DocumentIncludeFieldsEnum

string · enum

Enum values:

queue-metadata

workspace-metadata

locked-by

lock-status

approval-data

document-url

document-duplicities

workspace-subject-mismatch

DocumentIncludeLockedBy

idstring · uuid · required
emailstring · email · required

DocumentIncludeOrganization

idstring · uuid · required
humanized_idnumber · required
namestring · required
statusrequired

DocumentIncludeQueue

idstring · uuid · required
humanized_idnumber · required
typerequired

namestring | null

share_enabledboolean · required
share_urlstring | null · required
created_atstring | null · required
expires_atstring | null · required

DocumentIncludeWorkspace

idstring · uuid · required
namestring · required

DocumentLockStatusEnum

string · enum

Enum values:

LOCKED

UNLOCKED

DocumentLockStatusGetterResult

locked_atstring · date-time · required
locked_byrequired
User who locked the document
lockedboolean · required
Is document locked
locked_by_current_userboolean · required
Is document locked by current user
locked_for_current_userboolean · required
Is document locked for current user

DocumentLockStatusUser

idstring · uuid · required
namestring | null · required
emailstring · email · required

DocumentMetadataDto

idstring · uuid · required
confidencenumber | null · required
created_atstring · date-time · required
updated_atstring · date-time · required
queue_idstring · uuid · required
An ID of an associated Queue
statusrequired
page_countnumber · required
file_namestring · required
extraction_errorstring | null · required
line_items_visibilityrequired
tax_detail_visibilityrequired
email_idstring | null · required
inbox_status | null · required

internal_erp_idstring | null
An internal ID from the ERP system
export_errorstring | null
export_error_descriptionstring | null
marked_as_exported_atstring | null
marked_as_exporting_atstring | null
marked_as_ready_to_export_atstring | null
A 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_fromstring | null

DocumentMetadataResponseDto

dataobject · required

DocumentOcrDataResponseDto

dataobject[] · required

DocumentPageEditsDto

page_indexnumber · min: 0 · required
Page index of the parent document

rotation | null

DocumentPageImageDto

widthnumber · required
heightnumber · required
page_numbernumber · required
signed_urlstring · required
mime_typestring · required

DocumentPaginationDto

next_documentstring | null · uuid · required
previous_documentstring | null · uuid · required
positionnumber · required
total_countnumber · required

DocumentPaginationResponseDto

dataobject · required

DocumentRegistersApiResponse

dataobject[] · required
frequent_itemsobject[] · required
paginationobject · required

DocumentRotationEdit

number · enum

Enum values:

0

90

180

270

DocumentSection

string · enum

Enum values:

line-items

tax-details

DocumentSectionVisibility

string · enum

Enum values:

visible

hidden

DocumentStageEnum

string · enum

Enum values:

to-validation

to-approve

later

sent

deleted

rejected

spam

none

Document stage

DocumentStatusChangeWithUserType

changed_atstring · date-time · required
changed_torequired
changed_bystring | null · required
type | null · required
changed_by_idstring | null · required
changed_by_user_emailstring | null · required

DocumentStatusEnum

string · enum

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

DocumentTimeSpentStage

string · enum

Enum values:

to-validation

to-approve

later

DocumentValidationStatusItem

messagestring | null · required
severityrequired
message_keyrequired
description_keystring · required
descriptionstring · required

DocumentValidationStatusResponse

dataobject[] · required

DocumentWithIncludeExcludeMetadataDto

idstring · uuid · required
confidencenumber | null · required
created_atstring · date-time · required
updated_atstring · date-time · required
queue_idstring · uuid · required
An ID of an associated Queue
statusrequired
page_countnumber · required
file_namestring · required
extraction_errorstring | null · required
line_items_visibilityrequired
tax_detail_visibilityrequired
email_idstring | null · required
inbox_status | null · required
export_allowedboolean · required
approve_allowedboolean · required
annotations_edit_allowedboolean · required
skip_allowedboolean · required
deletion_allowedboolean · required
initiate_approval_allowedboolean · required
move_allowedboolean · required
rejection_allowedboolean · required
annotationsobject · 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}]}
current_approver_idsstring[] · required
advanced_approval_route_namestring | null · required
advanced_approval_featurerequired
Document approval status
locked_by_user | null · required
Document locked by user
lock_status | null · required
Document lock status
current_approver_labelstring | null · required
Current approver name or email
current_approver_labelsstring[] · required
Current approvers name or email
stagerequired
Document stage
rejection_reasonstring | null · required
Rejection reason
annotations_sourcerequired
Document source
annotations_source_type | null · required
last_status_change | null · required
Last document status change
status_change_historyobject[] · required
Last document status change
page_imagesobject[] · required
A list of document page images
page_edits_historyobject[] · required
ocr_dataobject[] · required
received_from_namestring | null · required
uploaded_by_namestring | null · required
email_subjectstring | null · required

internal_erp_idstring | null
An internal ID from the ERP system
export_errorstring | null
export_error_descriptionstring | null
marked_as_exported_atstring | null
marked_as_exporting_atstring | null
marked_as_ready_to_export_atstring | null
A 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_fromstring | null
queue_features | null
organization | null
Document's organization
workspace | null
Workspace of document's queue
queue | null
Document's queue
approved_by_current_userboolean | null
Is document approved by current user
approval_processarray | null
advanced_approval_status | null
Document global approval status
payment_status | null
Document payment status
payment_status_labelstring | null
Document payment status label
document_urlstring | null
Document url
has_duplicitiesboolean | null
Boolean flag if document has duplicities
workspace_subject_mismatch | null
has_attachmentsboolean | null
Boolean flag if document has attachments
comments_countnumber
last_modified_atstring | null
received_atstring | null
first_page_imagestring | null
share_status | null
Document's share status
advanced_approval_order | null
Document approval order

DocumentWithNextDocumentMetadata

documentobject · required
next_document | null · required

DocumentWithNextDocumentMetadataResponseDto

dataobject · required

DocumentsAggregatedCounts

by_stageobject · required
by_payment_statusobject · required

DocumentsApiResponse

dataobject[] · required
array of response data
paginationrequired
pagination

DocumentsCountAggregatedDto

uploadednumber · required
Number of documents to approve and to validate
sentnumber · required
Number of sent documents
datestring · date-time · required
workspacesobject[] · required

countnumber · deprecated · required
Deprecated, use "uploaded" instead

DocumentsCountPerDay

countnumber · required

DocumentsCountPerQueueAggregatedDto

queue_idstring · uuid · required
queue_namestring · required
queue_humanized_idnumber · required
uploadednumber · required
Number of documents to approve and to validate
sentnumber · required
Number of sent documents

DocumentsCountPerWorkspaceAggregatedDto

workspace_idstring · required
workspace_namestring · required
workspace_humanized_idnumber · required
uploadednumber · required
Number of documents to approve and to validate
sentnumber · required
Number of sent documents
queuesobject[] · required

DocumentsToApproveDto

dataobject[] · required
A list of documents

EditPagesDto

documentsobject[] · minItems: 1 · required

original_document_change_action | null

EditPagesResponse

document_idsstring[] · required

EmailDto

idstring · uuid · required
created_atstring · date-time · required
A datetime in ISO8601 with time zone
updated_atstring · date-time · required
A datetime in ISO8601 with time zone
fromstring · required
subjectstring · required
body_plain_textstring · required
body_htmlstring · required

EmailImportNotificationDto

recipientstring · email · required

EmailWithRolesInWorkspaceQueuesDto

emailstring · email · required
workspacesobject[] · required

EmbeddedAccessRequestDto

return_urlstring · url
An url to redirect after embedded document is processed
cancel_urlstring · url
An url to redirect after embedded document is cancelled
user_idstring | null · uuid
Another user id to create embedded access for

EmbeddedAccessResponseDataDto

dataobject · required

EmbeddedAccessResponseDto

tokenstring · required
embedded_urlstring · url · required
URL must be a valid HTTP URL
return_urlstring | null · url · required
URL must be a valid HTTP URL
cancel_urlstring | null · url · required
URL must be a valid HTTP URL
embedded_token_user_idstring · uuid · required
embedded_token_user_ui_localerequired

EmitIntegrationConnectionStatusChange

workspace_idstring · uuid · required
dataobject · required

EmitSseDocumentExportProgress

user_idstring · uuid · required
organization_idstring · uuid · required
dataobject · required

EmitSseDocumentExtracted

queue_idstring · uuid · required
dataobject · required

EmitSseNotificationReceived

user_idstring · uuid · required
organization_idstring · uuid · required
dataobject · required

EnhancedUserDto

idstring · uuid · required
ui_localerequired
namestring | null · required
emailstring · email · required
statusrequired
created_atstring · date-time · required
profile_avatar_urlstring | null · required

EnqueueDocumentsToExtractionDto

queue_idstring · uuid · required
An ID of a queue

idsarray | null
Comma separated document ids
searchstring
filters | null

EnqueueToExtractionFilters

idsarray | null
Comma separated document ids

EntityTypeEnum

string · enum

Enum values:

organization

workspace

queue

document

customer

email

ErpListCurrentReleaseDto

versionstring · required
regionstring · required
linkstring · required
release_notesstring · required
publication_datestring · date · required

ErpListIntegrationDto

idstring · uuid · required
logostring | null · required
namestring · required
accounting_systemrequired
api_versionrequired

ErpListItemDto

integrationobject · required
workspaceobject · required
legacy_tokenstring | null · required
Legacy V1 workspace token
tokenstring | null · required
Service account token
current_release | null · required

ErpListWorkspaceDto

idstring · uuid · required
namestring · required
versionstring | null · required
humanized_idnumber · required
access_actionsstring[] · required
Enum values:
read
update
delete
upload-document
update-document
update-document-stage
lock-document
validate-annotations

ExcludeFieldsEnum

string · enum

Enum values:

tax-details

line-items

ExportColumnEnum

string · enum

Enum values:

visible

all

ExportFileNameSourceEnum

string · enum

Enum values:

sender_name

sender_register_id

invoice_id

internal_erp_id

original_filename

ExportOptionsDto

export_line_itemsboolean | null
export_columns_options | null

ExportableEntity

string · enum

Enum values:

attachments

documents

audit_logs

ExternalValidationLinkDto

urlstring · url · required
URL must be a valid HTTP URL
signature_verificationrequired

ExternalValidationLinksDto

document_validation | null
initial_document_validation | null

ExternalValidationLinksResponseDto

data | null · required

ExternalValidationType

string · enum

Enum values:

initial_document_validation

document_validation

ExtractionEvaluation

string · enum

Enum values:

enabled

disabled

ExtractionEvaluationConfidence

number · enum

Enum values:

50

60

70

80

90

95

99

ExtractionEvaluationDto

document_confidence | null · required
fieldsobject[] · required

ExtractionEvaluationFieldDto

confidence | null · required
fieldstring · required

validation_resultstring | null

ExtractionEvaluationResponseDto

dataobject · required

ExtractionLocale

string · enum

Enum values:

cs

sk

en

FailedImportSettingsDto

enabledboolean | null
empty_email_importarray | null

FeatureFlagsDto

billingboolean | null
annotation_detailboolean | null
drive_uploadboolean | null
inboxboolean | null
import_csv_line_itemsboolean | null
commentsboolean | null
approval_routes_settingsboolean | null
approval_groupsboolean | null
postgres_registers_searchboolean | null
out_of_officeboolean | null

FieldFormattingStatus

string · enum

Enum values:

enabled

disabled

Whether schema field should be formatted by Digitoo App UI during selection.

FileExportTypeEnum

string · enum

Enum values:

csv

pdf

pdf_with_isdoc

png

isdoc

xml

xlsx

File export type

FilterableFieldData

keystring · required
Annotation schema field key
messagestring · required
Annotation schema field message
filter_typerequired
Type of returned filter

FilterableFieldsResponse

dataobject[] · required

FiltersDocumentStatusChangeDto

source | null

FiltersQueryMetadataDto

idsarray | null
Comma separated document ids
stagestring[]
Comma separated document stage
Enum values:
to-validation
to-approve
later
sent
deleted
rejected
spam
none
statusstring[]
Comma separated document status
Enum values:
received
enqueued-for-extraction
extraction-errored
extraction-rejected
waiting-for-human-validation
waiting-for-human-approval
deleted
postponed
payment_statusstring[]
Comma separated document payment status
Enum values:
paid
unpaid
to_pay
payment_order
past_due
inbox_statusstring[]
Comma separated document inbox status
Enum values:
sorted
unsorted
last_modified_date_gtestring | null · date-time
last_modified_date_ltestring | null · date-time
last_status_change_at_gtestring | null · date-time
last_status_change_at_ltestring | null · date-time
created_at_gtestring | null · date-time
created_at_ltestring | null · date-time
last_modified_byarray | null
current_approver_idstring | null · uuid
current_approver_idsarray | null
global_approval_statusstring[]
Enum values:
undetermined
initiated
pending
approved
declined
advanced_approval_statusstring[]
Enum values:
undetermined
initiated
pending
approved
declined
approval_statusstring[]
Enum values:
enabled
disabled
advanced_approval_feature
approval_route_usersarray | null
approval_process_usersarray | null
approved_by_usersarray | null
workspace_idarray | null
organization_idarray | null
received_fromarray | null
source | null
advanced_approval_route_namearray | null
internal_erp_idarray | null
has_share_linkarray | null

FrequentItemsDto

enabledboolean · required
annotationstring · required
sizenumber · required

GetAboPaymentDataAux

document_idstring · uuid · required
payment_statusrequired
errorsstring[] · required
Enum values:
missing_value
invalid_bank_account
unable_to_pay_negative_amount
unable_to_pay_zero_amount
already_paid
invalid_currency
error_messagesstring[] · required
eligible_to_pay_aboboolean · required
eligible_to_pay_qrboolean · required
abo_dataobject · required
qr_dataobject · required

GetAboPaymentDataResponse

dataobject[] · required

GetAnnotationConfidenceResponseDto

dataobject · required
A list of annotations confidences

GetAnnotationValuesResponseDto

dataobject · 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}]}

GetBankAccountsResponseDto

dataobject[] · required

GetDocumentAttachmentsDto

dataobject[] · required

GetDocumentDuplicitiesResponseDataDto

duplicities_countnumber · min: 0 · required
number of existing duplicities
duplicitiesobject[] · required
List of all duplicities

GetDocumentDuplicitiesResponseDto

dataobject · required

GetDocumentsCountAggregatedDto

dataobject[] · required

GetDocumentsCountDto

dataobject · required

GetEmailAttachmentsDto

dataobject[] · required

GetEmailResponseDto

dataobject · required

GetIntegrationAgentReleasesDto

dataobject[] · required

GetLineItemsTemplateDto

dataobject · required

GetLineItemsTemplatesDto

dataobject[] · required

GetLinkedAccountsResponse

dataobject[] · required

GetRefreshTokenDto

dataobject · required

GetSepaPaymentDataAux

document_idstring · uuid · required
payment_statusrequired
errorsstring[] · required
Enum values:
missing_value
invalid_iban
invalid_bic
country_mismatch_iban_bic
unable_to_pay_negative_amount
unable_to_pay_zero_amount
already_paid
error_messagesstring[] · required
eligible_to_pay_sepaboolean · required
sepa_dataobject · required

GetSepaPaymentDataResponse

dataobject[] · required

GetStatusChangeCountsAggregatedDto

dataobject[] · required

GetStatusChangeCountsDto

dataobject[] · required

GetStatusHistoryCountsDto

dataobject[] · required

GetSubjectCountry

string · enum

Enum values:

AT

BE

BG

CY

DE

DK

EE

EL

GetSubjectDto

namestring · required
addressstring · required
streetstring · required
citystring · required
post_codestring · required
countrystring · required

GetSubjectResponse

dataobject · required

GetTimeSpentHistoryReportResponseDto

dataobject[] · required

GetTimeSpentPerDocumentReportResponseDto

dataobject[] · required

GetTimeSpentPerSessionReportResponseDto

dataobject[] · required

GetTimeSpentPerUnitReportResponseDto

dataobject[] · required

GetTimeSpentPerUserReportResponseDto

dataobject[] · required

GetTokenResponseDto

dataobject · required

GetWorkspaceIntegrationStatusResponseDto

dataobject · required

HighestUserRoleInOrganizationDto

organization_idstring · uuid · required
highest_rolerequired

InboxDocumentCountsData

unsortednumber · required
returns count of inbox documents which were not sorted automatically
sortednumber · required
returns count of inbox documents which were sorted
spamnumber · required
returns count of inbox documents which are considered spam
deletednumber · required
returns count of inbox documents which have been deleted
totalnumber · required
returns count of all inbox documents

InboxDocumentCountsResponseDto

datarequired
response data

InboxQueueDto

idstring · uuid · required

IncludeFeatureStatus

string · enum

Enum values:

enabled

disabled

IncludeFilterMetadataEnum

string · enum

Enum values:

last-status-change-user

approved-by-user

IntegrationAPIVersion

string · enum

Enum values:

v1

v2

IntegrationAgentReleasesDto

idstring · uuid · required
download_linkstring · url · required
URL must be a valid HTTP URL
versionstring · required
notesstring · required
created_atstring · date-time · required

IntegrationAuthType

string · enum

Enum values:

oauth

token

IntegrationCertification

string · enum

Enum values:

active

pending

IntegrationConnectionStatusEnum

string · enum

Enum values:

unconnected

initial_connection_established

connection_error

connecting

Connection status of workspace

IntegrationDto

idstring · uuid · required
namestring · required
erp_coderequired
regionrequired
logostring · required
service_urlstring | null · url · required
typerequired
statusrequired
auth_typerequired
certificationrequired
settingsobject · required
formobject · required

IntegrationLogDto

typerequired
Event type
messagestring · required
Human-readable message for user

document_idstring · uuid
Document ID reference in case an event is directly associated to the document
detailsobject
An object used for storing miscellaneous data related to the event and used for debugging

IntegrationPrices

monthly_contract | null
yearly_contract | null
biyearly_contract | null

IntegrationResponseDto

dataobject · required

IntegrationSettingsDto

queue_typesstring[] · required
Enum values:
issued-invoice
received-invoice
receipt
contract-order
inbox
other

alternative_titlestring | null
alternative_descriptionstring | null
subtitle | null
partner | null

IntegrationSettingsPartnerDto

namestring · required

logostring | null
name_visibility | null

IntegrationSettingsSubtitleDto

textstring · required

tooltip | null

IntegrationSettingsSubtitleTootlipDto

titlestring · required

subtitlestring | null

IntegrationStatus

string · enum

Enum values:

active

coming

beta

IntegrationStatusDto

erp_coderequired
connection_statusrequired
global_errorstring | null · required
Integration error
global_error_descriptionstring | null · required
Integration error description
versionstring | null · required
Integration version
update_available | null · required
New version of integration
tokenstring · required
integrationobject · required

IntegrationStatusUpdateAvailableDto

versionstring · required
New version of integration
linkstring · required
Download link of the new integration version

IntegrationType

string · enum

Enum values:

external

plugin

service

service_plugin

none

IntegrationsResponseDto

dataobject[] · required

InternalRegistersApiResponse

dataobject[] · required
paginationobject · required

LegacyApprovalRouteUserDto

idstring · uuid · required
emailstring · email · required
namestring · required
Example: John Doe

LineItemsDataResponse

line_itemsobject[] · required
totalsobject[] · required

LineItemsResponseDto

dataobject · required
paginationobject · required

LineItemsRestorationSource

string · enum

Enum values:

original

after_initial_validation

LineItemsTemplate

idstring · uuid · required
namestring · required
workspace_idstring | null · uuid · required

LinkedAccountDto

idstring · uuid · required
emailstring · required
typerequired
created_atstring · date-time · required

string · enum

Enum values:

google

microsoft

LocalizedUserNotificationDto

idstring · uuid · required
typerequired
statusrequired
created_atstring · date-time · required
action_linksstring[] · required
messagestring · required

LockStatusRequestDto

lock_statusrequired

LockStatusResponseDataDto

datarequired
Document lock status

LogTypeEnum

string · enum

Enum values:

debug

error

info

success

warning

Event type

emailstring · email · required
passwordstring · required

tokenstring · required

dataobject · required

MarkBasicAnnotationSeenInputDto

fieldstring · required
Annotation field to be updated

indexnumber · min: 0
Zero based index of the annotation value of a field. Mostly used for multivalue fields.

MarkSeenTableAnnotationAuxDto

annotation_changesobject[] · required
register_changesobject[] · required
global_status | null · required
Annotations global status

MarkSeenTableAnnotationResponseDto

dataobject · required

MarkTableAnnotationSeenInputDto

fieldstring · required
Annotation field to be updated
table_keyrequired
Annotation table to be updated
row_indexnumber · min: 0 · required
Annotation table row index (0-based) to be updated

indexnumber · min: 0
Zero based index of the annotation value of a field. Mostly used for multivalue fields.

MembershipAccessActions

string · enum

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

MembershipDto

idstring · uuid · required
rolerequired
entity_idstring · uuid · required
entity_typerequired

workspace_idstring | null · uuid
include_actionsstring[]
Enum values:
read
update
delete
upload-document
update-document
update-document-stage
lock-document
validate-annotations

MembershipResponseDto

usersobject[] · required
workspacesobject[] · required
queuesobject[] · required

MembershipRoleEnum

string · enum

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

MembershipsResponseDto

dataobject · required

MoveDocumentsDto

queue_idstring · uuid · required

filtersobject
sortobject
paginationobject
searchstring | null
re_extraction | null
status | null

MoveDocumentsResponseDto

affectednumber · required
not_affectednumber · required
documents_idsstring[] · required

NotificationFiltersDto

statusstring[]
Enum values:
seen
unseen
dismissed

NotificationSettingsDto

approval_action_emailboolean · required
Whether to send an email when new approval for document is requested
approval_summary_emailboolean · required
Whether to send an email with summary of documents with requested approval
in_app_notificationsboolean · required
Whether to show in-app notifications
manual_email_approvalboolean · required
Whether to require manual approval
annotation_comment_mention_emailboolean · required
Whether to send an email when mentioned in an annotation comment

NotificationSortDirection

string · enum

Enum values:

ASC

DESC

NotificationSortDto

fieldrequired
directionrequired

NotificationSortEnum

string · enum

Enum values:

created_at

NotificationStatus

string · enum

Enum values:

seen

unseen

dismissed

NotificationType

string · enum

Enum values:

document_export

annotation_comment_mention

NotifyApproversSettingsEnum

string · enum

Enum values:

notify

ignore

Should be current approvers notified. Default is to notify.

NullableWebhookSigningKeyDto

webhook_signing_keystring | null · required

NullableWebhookSigningKeyResponseDto

dataobject · required

OnboardingOrigin

string · enum

Enum values:

DEMO

REGISTRATION

OrganizationApprovalRouteDto

idstring · uuid · required
orderrequired
namestring | null · required
name_with_usersstring · required
Example: Scenario (John Doe, ... +3)
queue_idstring · uuid · required
usersobject[] · required
itemsarray · required
queue_namestring · required
workspace_idstring · uuid · required
workspace_namestring · required
workspace_icon_colorstring · required

OrganizationApprovalRoutesResponseDto

dataobject[] · required

OrganizationBillableFeaturesDto

enforce_features_constraintsboolean · required
enforce_remaining_creditsboolean · required
workspace_count_limitnumber · required
users_count_limitnumber · required
approvers_count_limitnumber · required
contract_period | null · required
billingboolean · required
tierrequired
contract_period_started_atstring | null · required
contract_period_ends_atstring | null · required
total_paidnumber | null · required
featuresobject · required
integrationsstring[] · required

support | null

OrganizationDto

idstring · uuid · required
humanized_idnumber · required
namestring · required
tax_idstring | null · required
vat_idstring | null · required
register_idstring | null · required
house_numberstring | null · required
streetstring | null · required
citystring | null · required
zipstring | null · required
countrystring | null · required
statusrequired
inbox_statusrequired

access_actionsstring[]
Enum values:
read
update
delete
upload-document
update-document
update-document-stage
lock-document
validate-annotations
approval_metadata | null
first_queue_idnumber | null
inbox_queue | null
billable_features | null
billing_credits | null
settingsobject
user_settingsobject
webhook_signing_keyobject | null

OrganizationErpListResponseDto

dataobject[] · required

OrganizationInboxStatus

string · enum

Enum values:

enabled

disabled

OrganizationIncludeFields

string · enum

Enum values:

access-actions

approval-metadata

settings

first-queue-id

user-settings

inbox-queue

billing-credits

OrganizationResponseDto

dataobject · required

OrganizationSettingsDto

annotation_schema_columnsobject[] · required
possible_schema_columnsobject[] · required
merged_annotation_schemaobject[] · required

OrganizationSettingsResponseDto

dataobject · required

OrganizationStatusEnum

string · enum

Enum values:

undetermined

demo

in_trial_period

in_grace_period

paying

disabled

free

internal

OrganizationUnitsCountResponseDto

dataobject · required

OrganizationUserSettingsDto

workspace_order_byrequired
workspace_order_directionrequired

OrganizationsResponseDto

dataobject[] · required

OrganizationsUnitsCountDto

workspaces_countnumber · required
queues_countnumber · required
can_create_workspaceboolean · required
can_create_queueboolean · required

OriginalDocumentChangeActionStrategy

string · enum

Enum values:

keep

soft_delete

move_to_deleted

OtpStatus

string · enum

Enum values:

disabled

unverified

enabled

OutOfOfficeCreateDto

start_datestring · date-time · required
end_datestring · date-time · required
delegationobject · required

OutOfOfficeDelegationDto

delegate_to_user_idstring · uuid · required
overridesobject[] · required

OutOfOfficeDto

idstring · uuid · required
user_idstring · uuid · required
organization_idstring · uuid · required
start_datestring · date-time · required
end_datestring · date-time · required
created_atstring · date-time · required
updated_atstring · date-time · required
delegationobject · required

OutOfOfficeQueueOverrideDto

queue_idsstring[] · required
user_idstring · uuid · required

OutOfOfficeResponseDto

dataobject · required

PageEditHistoryDto

pagesobject[] · minItems: 1 · required
parent_document_idstring · uuid · required
edited_atstring · date-time · required
edited_bystring · uuid · required

PaginationDto

page_numbernumber · required
page_sizenumber · required
total_countnumber · required
page_countnumber · required
has_previous_pageboolean · required
has_next_pageboolean · required

PaginationQuery

numbernumber · min: 1
The page number, starting from 1
Default: 1
sizenumber · min: 1 · max: 1000

PartialAnnotationSchemaFieldDto

keystring | null
optionsobject[]
multivalueboolean | null
messagestring | null
formatting | null
hiddenboolean | null
subfieldsobject[]
section_message_key | null
separator_keystring | null
looseboolean | null
requiredboolean
datatype | null
autofillarray | null
pattern_matching | null
default_value | null
hide_register_valueboolean | null
multilineboolean | null
accuracy_thresholdnumber
required_for_auto_sendboolean | null
frequent_items | null
numeric_type | null
max_lengthnumber

PartialAnnotationSchemaSubfieldDto

keystring · required

multivalueboolean | null
formatting | null
hiddenboolean | null
messagestring | null
message_keystring | null
requiredboolean
datatype | null
default_value | null
hide_register_valueboolean | null
autofillarray | null
pattern_matching | null
accuracy_thresholdnumber
max_lengthnumber

PartnerNameVisibility

string · enum

Enum values:

hidden

visible

PasswordChangeDto

user_localerequired
tokenstring · required

PasswordChangeTokenResponseDto

dataobject · required

PatchAccountingAutomationDto

namestring | null
action
action_paramsobject
conditionsobject

PatchAnnotationColumnItem

keystring · required
visibilityboolean · required

widthnumber | null

PatchAnnotationColumnsInput

columnsobject[] · required

PatchAnnotationCommentDataDto

contentobject[] · minItems: 1 · required

PatchAnnotationSchemaBodyDto

annotation_fieldsobject[] · required

PatchApprovalAutomationDto

namestring | null
action
action_params | null
conditionsobject

PatchDocumentApprovalActionDto

statusrequired

notify_current_approvers | null
Should be current approvers notified. Default is to notify.
Default: notify
new_approverstring | null
messagestring | null
next_document | null

PatchDocumentApprovalDto

statusrequired

PatchDocumentApprovalResponseDto

dataobject · required

PatchDocumentApprovalRouteDto

approval_route_idstring | null · uuid · required

PatchDocumentApprovalWithNextDocumentDto

idstring · uuid · required
approval_route_idstring | null · uuid · required
approval_route_type | null · required
approval_featurerequired
approval_processarray · required
approval_statusrequired
route_namestring | null · required
approval_route_orderrequired
next_documentstring | null · uuid · required

share_enabledboolean · required
True for enable, false for disable

expires_atstring | null · date-time

dataobject · required

PatchDocumentStatusDto

statusrequired
New document status

internal_erp_idstring | null
Returned internal document id from ERP. Applied only if new status is exported
export_errorstring | null
Error message from ERP. Applied only if new status is export-errored
export_error_descriptionstring | null
Error description from ERP. Applied only if new status is export-errored

PatchInboxStatusBodyDto

inbox_statusrequired

filtersobject
sort | null
page | null
searchstring | null

PatchInboxStatusResponseDataDto

affectednumber · required
not_affectednumber · required

PatchInboxStatusResponseDto

dataobject · required

PatchInternalErpIdDto

internal_erp_idstring | null · required

PatchLineItemsTemplateInput

namestring · maxLength: 100 · required

PatchNextDocumentDto

filtersobject
sort | null
searchstring | null

PatchNotificationFiltersDto

idsstring[]
Example: ["9322c384-fd8e-4a13-80cd-1cbd1ef95ba8","986dcaf4-c1ea-4218-b6b4-e4fd95a3c28e"]
statusesstring[]
Enum values:
seen
unseen
dismissed

PatchNotificationsStatus

filtersobject · required
statusrequired

PatchOrganizationInputDto

namestring
vat_idstring | null
tax_idstring | null
register_idstring | null
house_numberstring | null
streetstring | null
citystring | null
countrystring
inbox_status | null
zipstring

PatchOrganizationResponseDto

dataobject · required

PatchOrganizationWorkspaceOrderingRequest

fieldrequired
dirrequired

orderobject[]

PatchPushTokenStatusDto

statusrequired

PatchQueueAccountingAutomationDto

statusrequired

PatchQueueAutomationRulesDto

statusrequired

PatchQueueDto

namestring | null
inbox_hash_prefixstring
Example: main-workspace.received-invoices

PatchQueueExtractionEvaluationDto

statusrequired

PatchSectionVisibilityRequest

sectionrequired
visibilityrequired

PatchSectionVisibilityResponse

dataobject · required

PatchSectionVisibilityResponseData

sectionrequired
visibilityrequired

PatchSetPaymentStatusBodyDto

statusrequired

PatchUserLanguageRegionDto

ui_localerequired

PatchUserNameDto

namestring | null

PatchUserNotificationSettingsDto

approval_action_emailboolean
Whether to send an email when new approval for document is requested
approval_summary_emailboolean
Whether to send an email with summary of documents with requested approval
in_app_notificationsboolean
Whether to show in-app notifications
manual_email_approvalboolean
Whether to require manual approval
annotation_comment_mention_emailboolean
Whether to send an email when mentioned in an annotation comment

PatchUserOnboardingStatusDto

originrequired
organization_idstring · uuid · required
namestring · required
phonestring · required
rolestring · required
companystring · required
register_idstring · required
vat_idstring · required
erpstring · required
invoice_countnumber · required

PatchWorkspaceConnectionStatusDto

integration_connection_statusrequired
Connection status of workspace

global_errorstring
Global error of workspace eg. connection issues
global_error_descriptionstring | null
Global error description of workspace eg. connection issues

PatchWorkspaceDto

namestring | null · minLength: 1
A name of the workspace
register_idstring | null
tax_idstring | null
vat_idstring | null
icon_colorstring | null · pattern: ^#?([0-9A-F]{3}|[0-9…

PatternMatchingChunkingStrategy

string · enum

Enum values:

ALL

EACH

PatternMatchingDto

patternstring · required

chunking_strategy | null
transform_chunksarray | null

PatternMatchingParamsDto

patternstring · required
chunking_strategyrequired

transform_chunksstring[]

PaymentStatus

string · enum

Enum values:

paid

unpaid

to_pay

payment_order

past_due

Document payment status

PostAccountingAutomationDto

namestring | null · required
actionrequired
action_paramsobject · required
conditionsobject · required

PostAnnotationCommentBodyDto

contentobject[] · minItems: 1 · required

parent_idstring | null · uuid
region | null

PostAnnotationTableAppendRowRequestDto

table_keyrequired
Example: line_items

PostAnnotationTableDuplicateRequestDto

table_keyrequired
Example: line_items
indexnumber · min: 0 · required
Annotation table row index (0-based) to be duplicated

PostAnnotationTableRemoveAllRequestDto

table_keyrequired
Example: line_items

PostAnnotationTableRemoveRowRequestDto

table_keyrequired
Example: line_items
indexnumber · min: 0 · required
Annotation table row index (0-based) to be removed

PostAnnotationTableRemoveRowsRequestDto

table_keyrequired
Example: line_items
indexesnumber[] · required

PostApprovalAutomationDto

namestring | null · required
actionrequired
action_params | null · required
conditionsobject · required

PostApprovalRouteDto

orderrequired
namestring · required

usersstring[] · minItems: 1
itemsarray · minItems: 1

PostApprovalRouteGroupDto

approval_group_idstring · uuid · required
approval_group_policyrequired

PostApprovalRouteUserDto

user_idstring · uuid · required

PostBulkMoveDocumentsResponseDto

dataobject · required

PostBulkPaymentRequest

filtersobject · required
payment_statusrequired

searchstring | null

PostConnectLinkedAccountResponseDto

dataobject · required

PostDocumentForgetBodyDto

field_keystring · required

indexnumber

PostDocumentLearnBodyDto

annotationsobject · 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}]}]}

line_items_visibility | null
tax_detail_visibility | null

PostDocumentWithNextDocumentDto

lock_next_documentboolean · required
next_documentobject · required
stagerequired

rejection_reasonstring | null

PostDocumentsStageDto

filtersobject · required
queue_idstring · uuid · required
stagerequired

rejection_reasonstring | null
searchstring | null

PostFreeSubscriptionDto

productsobject[] · required

PostInviteUsers

email_with_roles_in_workspace_queuesobject[] · required

PostInviteUsersResponseDto

datastring[] · required
successfully_invited_user_emailsstring[] · required
unsuccessfully_invited_user_emailsstring[] · required

PostInviteUsersToOrganizationBodyDto

usersobject[] · required

PostInviteUsersToOrganizationMembershipDto

entity_typerequired
entity_idstring · required
rolerequired

include_actionsarray | null

PostInviteUsersToOrganizationResponseDataDto

invitedobject[] · required
erroredobject[] · required

PostInviteUsersToOrganizationResponseDto

dataobject · required

PostInviteUsersToOrganizationResponseErroredDto

emailstring · email · required
reasonstring · required

PostInviteUsersToOrganizationUserDto

emailstring · email · required
membershipsobject[] · required

PostLineItemsTemplateInput

namestring · maxLength: 100 · required
document_idstring · uuid · required

emailstring · email · required
Email on which the share link will be sent

subjectstring | null
messagestring | null

PostQueueSetSchemaVisibilityInputDto

fieldsobject[] · required
A list of fields to update

PostRelearnBodyDto

namestring | null · required
register_idstring | null · required
tax_idstring | null · required
valuestring | null · required
field_keystring · required

PostSessionCheckoutDto

productsobject[] · required
contract_periodrequired

success_urlstring | null
cancel_urlstring | null

emailstring · email · required
id_tokenstring · required

Price

idstring · required
currencystring · required
activeboolean · required
typestring · required
unit_amountnumber | null · required

tiersobject[]

Prices

monthly | null
yearly | null
biyearly | null

PushTokenStatus

string · enum

Enum values:

enabled

paused

expired

PutApplyLineItemsTemplateInputDto

template_idstring · uuid · required

PutApprovalRouteDto

orderrequired

usersstring[] · minItems: 1
itemsarray · minItems: 1
namestring

PutDocumentApprovalRouteDto

orderrequired

usersstring[]
itemsarray

QueueApiResponse

dataobject · required

QueueCreationOptionsDto

typerequired
namestring | null · minLength: 1 · required
A name of a queue
localerequired
currencystring · minLength: 1 · required
Currency assigned to the queue (ISO code)

approvalboolean | null
Whether to use approval flow
Default: false
extractionboolean | null
Whether to allow extraction of documents
Default: true

QueueDocumentsCountResponseDto

datarequired
Documents aggregated counts for queue

QueueExcludeFields

string · enum

Enum values:

annotation-schema

QueueFeatureRequest

enabledboolean · required

QueueFeatureResponse

enabledboolean · required

QueueFeatureStatusEnum

string · enum

Enum values:

enabled

disabled

QueueFeaturesDto

extractionrequired
approvalrequired
relearningrequired
isdoc_extractionrequired
invalid_invoice_detectionrequired
bounce_emailrequired
ai_template_matchingrequired
ai_line_items_template_matchingrequired
ai_automated_accountingrequired
advanced_approvalrequired
advanced_approval_auto_exportrequired
audit_logrequired
queue_schema_per_userrequired
split_document_by_qr_coderequired
registers_frequent_itemsrequired
show_to_validationrequired
disable_approval_rejectrequired
approval_with_noterequired
annotation_amounts_suggestionsrequired
context_template_matchingrequired
slovakian_receipt_qr_code_extractionrequired
delegate_approvalrequired

QueueIncludeFields

string · enum

Enum values:

access-actions

documents-to-process-count

settings

documents-count

features

workspace-metadata

extraction-evaluation

inbox

QueueResponseDto

dataobject · required

QueueSchemaContext

string · enum

Enum values:

user

queue

QueueSettingsDto

annotation_schema_columnsobject[] · required
possible_schema_columnsobject[] · required
user_schema_columnsobject[] · required

QueueSettingsResponseDto

dataobject · required

QueueTypeEnum

string · enum

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

other

QueueUserDto

idstring · uuid · required
namestring | null · required
emailstring · required
statusrequired
profile_avatar_urlstring | null · required

QueueUsersResponseDto

dataobject[] · required

QueueWithAnnotationSchemaDto

idstring · uuid · required
humanized_idnumber · required
created_atstring · date-time · required
A datetime in ISO8601 with time zone
typerequired
currencystring · required
workspace_idstring · uuid · required
organization_idstring · uuid · required
inbox_hashstring · required
inbox_hash_prefixstring · required
Example: main-workspace.received-invoices
inboxstring · required
extraction_evaluationrequired
automation_rulesrequired
accounting_automation_rulesrequired
extracted_pages_limitnumber · required
failed_import_settingsarray | null · required

namestring | null
annotation_schemaobject[]
An annotation schema
access_actionsstring[]
Enum values:
read
update
delete
upload-document
update-document
update-document-stage
lock-document
validate-annotations
documents_to_process_countnumber
settings
Queue settings
features | null
documents_count
Queue documents counts
workspace
Workspace metadata
extraction_evaluation_rule | null
validations_settingsobject

QueuesApiResponse

dataobject[] · required
A list of queues
paginationobject · required

QueuesResponseDto

dataobject[] · required

RangeFilterApiResponse

dataobject · required

RangeFilterField

minnumber | null · required
maxnumber | null · required

RawAnnotationValueDto

indexnumber · required
regionobject · required

value | null
raw_valuestring

ReExtractionEnum

string · enum

Enum values:

enabled

disabled

RefreshTokenRequestDto

refresh_tokenstring · required

RegionDto

leftnumber · required
topnumber · required
widthnumber · required
heightnumber · required
pagenumber · min: 1 · required

RegisterChangeDto

typestring · required

RegisterDto

idstring · uuid · required
typestring · required

RegisterInternalDto

idstring · uuid · required
typestring · required

internalboolean
hide_register_valueboolean

RegisterItemDto

valuestring | null · required
labelstring · required
shown_labelstring · required

RegisterOptionDto

labelstring · required
A label that will be shown in an UI
valuestring · required
A value that will be set when a user chooses this option

aliasstring | null
A value that will be used to check for historical data when values change

RegisterUploadMethod

string · enum

Enum values:

replace

append

upsert

RegistersApiResponse

dataobject[] · required
paginationobject · required

RegistersInternalResponseDto

dataobject[] · required

RemoveBasicAnnotationInputDto

fieldstring · required
Annotation field to be updated

indexnumber · min: 0
Zero based index of the annotation value of a field. Mostly used for multivalue fields.

ReportDateAggInterval

string · enum

Enum values:

day

month

ReportTimeSpentFiltersDto

annotations_source | null

RequestRegionPointDto

leftnumber · required
topnumber · required
pagenumber · min: 1 · required

ResetPasswordRequestDto

emailstring · email · required

RoleManageAffectedUserDto

user_idstring · uuid · required

RowValidationMessageDto

table_keystring · required
row_indexnumber · required
message | null · required

ScheduledTaskDto

affectednumber · required
not_affectednumber · required
idstring · uuid · required
statusrequired

ScheduledTaskResponseDto

dataobject · required

ScheduledTaskStatus

string · enum

Enum values:

pending

running

completed

failed

failed_to_clean

SchemaFieldVisibility

string · enum

Enum values:

visible

hidden

SearchDataScope

string · enum

Enum values:

CZ

SK

PL

SearchSubjectDto

namestring · required
registration_numberstring · required
tax_numberstring | null · required
vat_numberstring | null · required

SearchType

string · enum

Enum values:

name

registration_number

vat_number

SectionVisibilityEnum

string · enum

Enum values:

visible

hidden

SepaPaymentDialogAlphanumericDataType

valuestring | null · required
errorsstring[] · required
Enum values:
missing_value
invalid_iban
invalid_bic
country_mismatch_iban_bic
unable_to_pay_negative_amount
unable_to_pay_zero_amount
already_paid
validation_errorsobject[] · required

SepaPaymentDialogNumericDataType

valuestring | null · required
numeric_valuenumber | null · required
errorsstring[] · required
Enum values:
missing_value
invalid_iban
invalid_bic
country_mismatch_iban_bic
unable_to_pay_negative_amount
unable_to_pay_zero_amount
already_paid
validation_errorsobject[] · required

SepaPaymentItemData

sender_nameobject · required
ibanobject · required
bicobject · required
var_symobject · required
currencyobject · required
total_dueobject · required

SepaPaymentItemError

string · enum

Enum values:

missing_value

invalid_iban

invalid_bic

country_mismatch_iban_bic

unable_to_pay_negative_amount

unable_to_pay_zero_amount

already_paid

ServiceAccountTokenDto

access_tokenstring · required

ServiceAccountTokenResponseDto

dataobject · required

SetOrderAutomationRulesBodyDto

idsstring[] · required

SetSchemaFieldVisibilityDto

field_keystring · required
hiddenboolean · required

SetSchemaVisibilityResponseDto

dataobject[] · required
An annotation schema

SortDirection

string · enum

Enum values:

asc

desc

SortQuery

fieldstring · required
Either 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)
directionrequired

SseDocumentExportProgressDataDto

idstring · uuid · required
progressnumber · required

SseDocumentExtractedPayloadDto

document_idstring · uuid · required

StageAggregationData

stagerequired
durationnumber · required

StatusChangeCountsAggregatedDto

datestring · date-time · required
countnumber · required
usersobject[] · required

StatusHistoryCountsPerQueueDto

queue_idstring · uuid · required
queue_namestring · required
queue_humanized_idnumber · required
unresolvednumber · required
sentnumber · required
skippednumber · required
deletednumber · required
usersobject[] · required

StatusHistoryCountsPerWorkspaceDto

workspace_idstring · required
workspace_namestring · required
workspace_humanized_idnumber · required
unresolvednumber · required
sentnumber · required
skippednumber · required
deletednumber · required
queuesobject[] · required

StringBoolean

string · enum

Enum values:

true

false

StripeLineItem

pricestring · required

quantitynumber

StripeRangeParamsDto

gtnumber
gtenumber
ltnumber
ltenumber

StripeTiersDto

tiersobject[] · required
featuresobject[] · required
integrationsobject[] · required
user_pricesobject[] · required
workspace_pricesobject[] · required

StripeTiersResponseDto

dataobject · required

SubjectSearchResultResponse

dataobject[] · required

TableAnnotationChangeDto

table_keystring · required
fieldstring · required
row_indexnumber · required
indexnumber · required
valuesrequired
List of changed annotations

TaxDetailDataResponse

tax_detailobject[] · required

TaxDetailResponseDto

dataobject · required
paginationobject · required

ThirdPartyValidationSettingsDto

keyrequired
statusrequired

paramsobject

Tier

string · enum

Enum values:

trial

tier_1

tier_2

tier_3

TierDto

idstring · required
namestring · required
internal_idstring · required
ordernumber · required
included_usersnumber · required
included_approversnumber · required
included_workspacesnumber · required
included_documentsnumber · required
pricesobject · required
included_featuresobject[] · required

TierIncludedFeature

keystring · required
statusrequired

TierPrice

up_tonumber | null · required
unit_amountnumber | null · required

TimeSpentPerDocumentAggregationDto

queue_idstring · uuid · required
queue_namestring · required
queue_humanized_idnumber · required
workspace_idstring · required
workspace_namestring · required
workspace_humanized_idnumber · required
document_idstring · uuid · required
document_page_countnumber · required
durationnumber · required

TimeSpentPerQueueAggregationDto

queue_idstring · uuid · required
queue_namestring · required
queue_humanized_idnumber · required
durationnumber · required

TimeSpentPerSessionAggregationDto

queue_idstring · uuid · required
queue_namestring · required
queue_humanized_idnumber · required
workspace_idstring · required
workspace_namestring · required
workspace_humanized_idnumber · required
user_idstring · uuid · required
user_namestring | null · required
user_emailstring · required
document_idstring · uuid · required
document_page_countnumber · required
startstring · date-time · required
endstring · date-time · required
stagerequired
durationnumber · required

TimeSpentPerUserAggregationDto

user_idstring · uuid · required
user_namestring | null · required
user_emailstring · required
durationnumber · required

TimeSpentPerWorkspaceAggregationDto

workspace_idstring · required
workspace_namestring · required
workspace_humanized_idnumber · required
durationnumber · required
queuesobject[] · required

TokenResponseDto

access_tokenstring · required
JWT access token
refresh_tokenstring · required
JWT refresh token
expires_atstring · date-time · required
refresh_token_expires_atstring · date-time · required

UILocale

string · enum

Enum values:

cs_CZ

en_GB

cs

en

UpdateAnnotationAuxDto

annotation_changesobject | null · required
An object of annotations changes
Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}]}
register_changesobject[] · required
global_status | null · required
Annotations global status

UpdateAnnotationGlobalStatusDto

global_statusobject · required

UpdateAnnotationGlobalStatusResponseDto

dataobject · required

UpdateAnnotationResponseDto

dataobject · required

UpdateAnnotationSchemaDto

annotation_schemaobject[] · minItems: 1 · required
Example: [{"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

fieldstring · required
Annotation field to be updated
valuerequired
Annotation value object to be set

indexnumber · min: 0
Zero based index of the annotation value of a field. Mostly used for multivalue fields.

UpdateExternalValidationLinkDto

typerequired
urlstring · url · required
URL must be a valid HTTP URL

signature_verification | null

UpdateTableAnnotationAuxDto

annotation_changesobject[] · required
register_changesobject[] · required
global_status | null · required
Annotations global status
updated_totalsobject[] · required

row_validation_messagesarray | null

UpdateTableAnnotationInputDto

fieldstring · required
Annotation field to be updated
table_keyrequired
Annotation table to be updated
row_indexnumber · min: 0 · required
Annotation table row index (0-based) to be updated
valuerequired
Annotation value object to be set

indexnumber · min: 0
Zero based index of the annotation value of a field. Mostly used for multivalue fields.

UpdateTableAnnotationResponseDto

dataobject · required

UpdateWebhookDto

urlstring · url · required
URL must be a valid HTTP URL

signature_verification | null
destination_idstring | null · uuid

UploadDocumentAnnotationCommentsDataDto

contentobject[] · minItems: 1 · required

region | null

UploadDocumentEmailDataDto

subjectstring · required
body-htmlstring · required
senderstring · required

body-plainstring | null

UploadQueueRegistersDto

registersobject[] · minItems: 1 · required
methodrequired
queue_idstring · uuid · required

UploadRegisterRequest

typestring · required
optionsobject[] · required

UploadedFilesResponse

document_idsstring[] · required

UpsertUserReportSettingsBodyDto

dataobject · required

UserAggregationDataDto

user_idstring · uuid · required
user_namestring | null · required
user_emailstring · required
durationnumber · required
dataobject[] · required

UserApprovalStatus

string · enum

Enum values:

enabled

disabled

UserApprovalStatusDto

statusrequired

UserApprovalStatusResponseDto

dataobject · required

UserDto

idstring · uuid · required
ui_localerequired
namestring | null · required
emailstring · email · required
statusrequired
otp_statusrequired
onboarding_metadata | null · required
created_atstring · date-time · required
profile_avatar_urlstring | null · required

UserMembershipDto

userobject · required
is_manageableboolean · required
highest_role_in_organizationrequired
membershipsobject[] · required

UserNotificationsResponseDto

dataobject[] · required
array of response data
paginationrequired
pagination

UserOnboardingMetadataDto

phonestring | null · required
emailstring · email · required

companystring | null
register_idstring | null
vat_idstring | null
erpstring | null
invoice_countnumber

UserOtpResponseDto

dataobject · required

UserOtpSettingsDto

otp_secretstring | null · required
otp_uristring | null · required
otp_statusrequired
otp_last_verification_datestring | null · required

UserReportSettingsDto

user_idstring · uuid · required
organization_idstring · uuid · required
created_atstring · date-time · required
updated_atstring · date-time · required
dataobject · required

UserReportSettingsResponseDto

data | null · required

UserResponseDto

dataobject · required

UserRoleManageDataDto

user_idstring · uuid · required
operationsarray · required

UserRoleManageDeleteDataDto

actionstring · required
membership_idstring · uuid · required

UserRoleManageInsertDataDto

actionstring · required
rolerequired
entity_idstring · uuid · required
entity_typerequired

include_actionsstring[]
Enum values:
read
update
delete
upload-document
update-document
update-document-stage
lock-document
validate-annotations

UserRoleManageNotAffectedDto

user_idstring · uuid · required
errorstring · required

UserRoleManageResponseDto

dataobject · required

UserRolesInWorkspaceQueues

workspace_idstring | null · uuid · required
queuesobject[] · required

UserStatus

string · enum

Enum values:

initial

expired

enabled

disabled

UserStatusChangeBreakdownDto

statusrequired
countnumber · required

UserStatusChangeDto

user_idstring · uuid · required
user_namestring | null · required
user_emailstring · required
countnumber · required
statusesobject[] · required

UserStatusHistoryDto

user_idstring · uuid · required
user_namestring | null · required
user_emailstring · required
unresolvednumber · required
sentnumber · required
skippednumber · required
deletednumber · required

UserTypeEnum

string · enum

Enum values:

customer

service_account

UserWithDefaultOrganization

idstring · uuid · required
ui_localerequired
namestring | null · required
emailstring · email · required
statusrequired
otp_statusrequired
onboarding_metadata | null · required
created_atstring · date-time · required
profile_avatar_urlstring | null · required
organization_idstring | null · uuid · required
workspace_idstring | null · uuid · required
queue_idstring | null · uuid · required
organization_humanized_idnumber | null · required
workspace_humanized_idnumber | null · required
queue_humanized_idnumber | null · required
approval_dashboardboolean | null · required
highest_rolesobject[] · required
notification_settingsobject · required
feature_flagsobject · required
internal_testerboolean · required

UserWithDefaultOrganizationResponseDto

dataobject · required

UsersRoleManageBodyDto

usersobject[] · required

UsersRoleManageResponseDataDto

affected_usersobject[] · required
not_affected_usersobject[] · required

ValidatedAnnotationsDto

annotationsobject · 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}]}]}
global_status | null · required
Annotations global status

ValidatedAnnotationsResponseDto

dataobject · required

ValidationKey

string · enum

Enum values:

accounting_confidence_check

annotations_duplicates_remover

remove_entity_filterer

apply_approval_route

apply_document_template

apply_registers_preset

pattern_matching_applicator

required_values_check

ValidationMessageKey

string · enum

Enum values:

seen_by_human

value_required

default_value

value_derived

value_calculated_with_sources

value_exceeded_max_length

value_derived_with_source

value_derived_from_tax_detail

ValidationResultDto

messagestring | null · required
message_keyrequired
severityrequired

autofilled_fromstring
validation_key | null
validation_timestampnumber | null

ValidationSettingStatus

string · enum

Enum values:

enabled

disabled

ValueFilterApiResponse

dataobject[] · required

ValueFilterField

keystring · required

labelstring | null
hide_valueboolean | null

VerifyOtpDto

otpstring · required

WebhookApiResponseDto

dataobject · required

WebhookEntityTypeEnum

string · enum

Enum values:

organization

workspace

queue

document

WebhookResponseDto

idstring · uuid · required
entity_idstring · uuid · required
entity_typerequired
urlstring · url · required
URL must be a valid HTTP URL
signature_verificationrequired
typerequired

WebhookSignatureVerification

string · enum

Enum values:

enabled

disabled

WebhookSigningKeyDto

webhook_signing_keystring · required

WebhookSigningKeyResponseDto

dataobject · required

WebhookType

string · enum

Enum values:

document_status_changed

queue_created

initial_document_validation

document_validation

WebhooksApiResponseDto

dataobject[] · required

WorkspaceDto

idstring · uuid · required
humanized_idnumber · required
namestring · required
register_idstring | null · required
tax_idstring | null · required
vat_idstring | null · required
organization_idstring · uuid · required
global_errorstring | null · required
global_error_descriptionstring | null · required
integration_idstring · uuid · required
icon_colorstring · required
typerequired
integration_accounting_systemrequired

access_actionsstring[]
Enum values:
read
update
delete
upload-document
update-document
update-document-stage
lock-document
validate-annotations
documents_to_process_countnumber
queuesobject[]

WorkspaceIncludeFields

string · enum

Enum values:

access-actions

documents-to-process-count

queues

queue-extraction-evaluation

inbox

WorkspaceOrderBy

string · enum

Enum values:

name

createdAt

ordering

WorkspaceOrderDirection

string · enum

Enum values:

asc

desc

WorkspaceRegion

string · enum

Enum values:

cs

sk

uk

none

WorkspaceResponseDto

dataobject · required

WorkspaceSubjectIdMismatch

register_id_mismatchboolean · required
tax_id_mismatchboolean · required

WorkspaceType

string · enum

Enum values:

inbox

accounting

WorkspaceWithTokenDto

idstring · uuid · required
humanized_idnumber · required
namestring · required
register_idstring | null · required
tax_idstring | null · required
vat_idstring | null · required
organization_idstring · uuid · required
global_errorstring | null · required
global_error_descriptionstring | null · required
integration_idstring · uuid · required
icon_colorstring · required
typerequired
integration_accounting_systemrequired
tokenstring · required

access_actionsstring[]
Enum values:
read
update
delete
upload-document
update-document
update-document-stage
lock-document
validate-annotations
documents_to_process_countnumber
queuesobject[]

WorkspaceWithTokenResponseDto

dataobject · required

WorkspacesResponseDto

dataobject[] · required
array of response data
paginationrequired
pagination

Schemas

AboPaymentDialogAlphanumericDataType

AboPaymentDialogNumericDataType

AboPaymentFileType

AboPaymentItemData

AboPaymentItemError

AboPaymentSPD

AcceptableSettingsKeys

AccountAutomationAnnotation

AccountAutomationAnnotationWithMetadata

AccountingAutomationDto

AccountingAutomationListResponseDto

AccountingAutomationResponseDto

AccountingAutomationRule

AccountingAutomationRuleAction

AccountingAutomationRuleParams

AccountingAutomationRuleParamsWithMetadata

AccountingAutomationRules

AccountingConfidenceFieldSettingDto

AccountingConfidenceThreshold

AccountingConfidenceValidationParamsDto

AccountingSystemDto

AccountingSystemEnum

AddUserRoleInQueueDto

AdvancedApprovalFeatureEnum

AdvancedApprovalStatusEnum

AffectedEntitiesCountDto

AffectedEntitiesCountResponseDto

AmountAggregateDto

AmountAggregatesDto

AmountAggregatesResponseDto

AnnotationCommentDto

AnnotationCommentResponseDto

AnnotationCommentThreadDto

AnnotationCommentThreadsResponseDto

AnnotationDateValueDto

AnnotationFieldDto

AnnotationFieldRenderOptionDto

AnnotationFieldRenderTypeEnum

AnnotationGlobalMessageDto

AnnotationGlobalStatusResponseDto

AnnotationNumericSuggestionDto

AnnotationNumericValueDto

AnnotationSchemaColumnsDto

AnnotationSchemaDto

AnnotationSchemaFieldDataTypeEnum

AnnotationSchemaFilterableFieldType

AnnotationSchemaNumericType

AnnotationSchemaResponse

AnnotationSchemaSectionMessageKey

AnnotationSchemaSubfieldsDto

AnnotationSourceEnum

AnnotationSourceType

AnnotationTableField

AnnotationTableRowDto

AnnotationTableValueTotalDto

AnnotationValidationMessageSeverityEnum

AnnotationValueDto

AnnotationValueInput

AnnotationsFormattingEnum

AnnotationsGlobalStatusDto

ApprovalAutomationDto

ApprovalAutomationListResponseDto

ApprovalAutomationMatchDto

ApprovalAutomationMatchResponseDto

ApprovalAutomationResponseDto

ApprovalDocumentCountsData

ApprovalDocumentCountsResponseDto

ApprovalGroupCreateBodyDto

ApprovalGroupDto

ApprovalGroupItemDto

ApprovalGroupPutBodyDto

ApprovalGroupResponseDto

ApprovalGroupsResponseDto

ApprovalOrder

ApprovalProcessGroupItemDto

ApprovalProcessUserItemDto

ApprovalRouteDto

ApprovalRouteGroupDto

ApprovalRouteGroupPolicy