Schemas
AboPaymentDialogAlphanumericDataType
valueerrorsAboPaymentDialogNumericDataType
valuenumeric_valueerrorsAboPaymentItemData
AboPaymentItemError
AcceptableSettingsKeys
AccountAutomationAnnotationWithMetadata
fieldvaluelabelAccountingAutomationDto
idnamequeue_idcreated_atupdated_atactionvalidation_resultAccountingAutomationListResponseDto
AccountingAutomationResponseDto
AccountingAutomationRuleParams
AccountingAutomationRuleParamsWithMetadata
AccountingConfidenceFieldSettingDto
keywarning_thresholdAccountingConfidenceValidationParamsDto
warning_thresholdAccountingSystemDto
namecredentialsAccountingSystemEnum
AccuracyEntityKeyDto
entity_keyEntity key
entity_nameEntity name
accuracyAverage accuracy
AccuracyEntityTimeBucketDto
datePeriod start date
date_labelHuman-readable period label
AccuracyFilterDto
annotations_sourceDocument source
workspace_idsWorkspace IDs
queue_idsQueue IDs
vendorsVendors
AccuracyOrganizationPerDocumentDto
document_idDocument ID
document_urlDocument URL
workspace_nameWorkspace name
workspace_idWorkspace ID
queue_nameQueue name
queue_idQueue ID
accuracyAccuracy
uploaded_atUploaded at
AccuracyOrganizationPerDocumentResponseDto
AccuracyOrganizationPerEntityDto
workspace_idWorkspace ID
workspace_nameWorkspace name
AccuracyOrganizationPerEntityResponseDto
Per-interval entity breakdown when interval query param is set
AccuracyOrganizationPerQueueDto
workspace_nameWorkspace name
workspace_idWorkspace ID
queue_nameQueue name
queue_idQueue ID
documents_countNumber of documents
average_accuracyAverage accuracy
AccuracyOrganizationPerVendorDto
vendorVendor
avg_accuracyAverage accuracy
AccuracyOrganizationPerVendorResponseDto
Per-interval vendor breakdown when interval query param is set
AccuracyOrganizationPerWorkspaceDto
workspace_nameWorkspace name
workspace_idWorkspace ID
documents_countNumber of documents
average_accuracyAverage accuracy
AccuracyOrganizationPerWorkspaceResponseDto
Per-interval workspace breakdown when interval query param is set
AccuracyQueueDto
queue_idQueue ID
queue_nameQueue name
AccuracyTimeAggregatedDto
dateDate string
date_labelHuman-readable period label (e.g. ISO week, month)
avg_accuracyAverage accuracy
AccuracyTimeAggregatedResponseDto
AccuracyVendorQueueDto
queue_idQueue ID
queue_nameQueue name
AccuracyVendorTimeBucketDto
datePeriod start date
date_labelHuman-readable period label
AccuracyVendorWorkspaceDto
workspace_idWorkspace ID
workspace_nameWorkspace name
AccuracyWorkspaceTimeBucketDto
datePeriod start date
date_labelHuman-readable period label
AddUserRoleInQueueDto
idroleAdvancedApprovalStatusEnum
Document global approval status
AffectedEntitiesCountResponseDto
AmountAggregateDto
sumavgminmaxAmountAggregatesResponseDto
AnnotationCommentDto
idregioncreated_by_idcreated_atupdated_atdeleted_atdeletion_allowedparent_idAnnotationCommentResponseDto
AnnotationCommentThreadDto
idregioncreated_by_idcreated_atupdated_atdeleted_atdeletion_allowedAnnotationCommentThreadsResponseDto
AnnotationDateValueDto
valuelabelusage_counterregionraw_annotation_indicesvalidation_resultprobabilityiso_date_valueAnnotationFieldRenderOptionDto
valuelabellabel_keyAnnotationGlobalMessageDto
fieldsubfieldfield_messagesubfield_messagefield_message_keysubfield_message_keyvalidation_resultAnnotationGlobalStatusResponseDto
AnnotationNumericValueDto
valuelabelusage_counterregionraw_annotation_indicesvalidation_resultprobabilitynumeric_valueAnnotationSchemaColumnsDto
messagekeydatatypeEntity datatype. Mandatory only for field type item.
visibilitywidthAnnotationSchemaDto
typemessageLabel for entity field shown in Digitoo App UI. key will be used if not provided. Mandatory only for subtitle type item.
message_keyMessage key translation for entity field shown in Digitoo App UI. key will be used if not provided.
keyEntity identifier. Mandatory only for field type item.
datatypeEntity datatype. Mandatory only for field type item.
numeric_typeNumeric type for numeric fields.
Default value to apply if no value extracted by engine.
hiddenWhether an entity field should be initially hidden in UI. false will be used if not provided.
hide_register_valueWhether an register item should have visible value in Digitoo App UI. false will be used if not provided.
requiredwhether an entity field should be required to have value before exporting. false will be used if not provided.
required_bySource of the required flag: queue_schema (enforced by the ERP before export) or admin (enforced during approval by a user-scheme override).
autofillList of entities to initiate value from engine extracted values. Does not yet work for table entity subfields.
List of entities for table entities (currently only line_items and tax_detail are supported).
multivalueWhether an entity field should be rendered as multivalue.
section_message_keyAdds sectionMessageKey in order to sort on
separator_keyAdds separatorKey in order to sort on
multilinepattern_matchingupdated_by_userWhether schema field has been changed in Digitoo App UI.
formattingWhether schema field should be formatted by Digitoo App UI during selection.
max_lengthAnnotationSchemaFieldDataTypeEnum
Entity datatype. Mandatory only for field type item.
AnnotationSchemaFilterableFieldType
Type of returned filter
AnnotationSchemaResponse
AnnotationSchemaResponseDto
AnnotationSchemaSubfieldsDto
keyEntity identifier. Mandatory only for field type item.
datatypeEntity datatype. Mandatory only for field type item.
messageLabel for entity field shown in Digitoo App UI. key will be used if not provided. Mandatory only for subtitle type item.
hiddenWhether an entity field should be initially hidden in UI. false will be used if not provided.
requiredwhether an entity field should be required to have value before exporting. false will be used if not provided.
required_bySource of the required flag: queue_schema (enforced by the ERP before export) or admin (enforced during approval by a user-scheme override).
Default value to apply if no value extracted by engine.
hide_register_valueWhether an register item should have visible value in Digitoo App UI. false will be used if not provided.
pattern_matchingupdated_by_userWhether schema field has been changed in Digitoo App UI.
formattingWhether schema field should be formatted by Digitoo App UI during selection.
AnnotationTableRowDto
validation_resultAnnotationValueDto
valuelabelusage_counterregionraw_annotation_indicesvalidation_resultprobabilityAnnotationValueInput
valueAnnotation value string to be set
regionPosition of annotation in document
raw_annotation_indicesArray of annotation indices
AnnotationsGlobalStatusDto
export_allowedapprove_allowedannotations_edit_allowedskip_alloweddeletion_allowedinitiate_approval_allowedmove_allowedreset_allowedrejection_allowedmessageAll error and warning messages of the document, most severe first
ApplyRuleToDocumentDto
apply_to_unprocessedAlso apply the rule to the other unprocessed documents in the queue (not sent, not deleted)
ApprovalAutomationDto
idnamequeue_idcreated_atupdated_atactionvalidation_resultApprovalAutomationListResponseDto
ApprovalAutomationMatchDto
idnamequeue_idcreated_atupdated_atactionvalidation_resultapproval_processApprovalAutomationResponseDto
ApprovalDocumentCountsData
to_approvereturns count of documents which could be approved by current user
approvedreturns count of documents which had been approved by current user
rejectedreturns count of documents which had been rejected
sentreturns count of documents which had been approved and sent to ERP
allreturns count of documents which had been approved by current user and has stage 'ALL'
ApprovalGroupCreateBodyDto
nameApprovalGroupDto
idnamequeue_idcreated_atupdated_atdeleted_atApprovalGroupItemDto
user_idApprovalGroupPolicy
ApprovalGroupPutBodyDto
nameApprovalGroupResponseDto
ApprovalGroupsResponseDto
ApprovalImpactResponseDto
ApprovalImpactSummaryDto
Queues affected by removing or replacing this user
ApprovalOrder
Document approval order
ApprovalProcessGroupItemDto
approval_group_idapproval_group_nameapproval_group_policystatusApprovalProcessUserItemDto
user_idnamestatusmessageacted_atApprovalRouteDelegateItemDto
user_iduser_emailuser_nameApprovalRouteDto
idorderDocument approval order
namename_with_usersqueue_iddelegationrestrictionsApprovalRouteGroupDto
approval_group_idapproval_group_nameapproval_group_policyApprovalRouteGroupPolicy
ApprovalRouteResponseDto
ApprovalRouteUserDto
user_iduser_emailuser_nameApprovalRoutesResponseDto
ApprovalStatusData
approval_enabledtrue if at least one queue has enabled approval
documents_to_approve_countcount of documents to approve
ApprovalStatusEnum
AskStorageAiAssistantDto
promptnode_idchat_session_idAskStorageAiAssistantResponseDto
AttachmentDto
idcreated_atfile_pathfile_namemime_typefile_sizefile_size_human_readableurlURL must be a valid HTTP URL
AttachmentLinkBodyDto
entity_identity_typeAutomationBinaryArrayConditionBaseDto
operationvariablevaluesvalidation_resultAutomationBinaryArrayConditionDto
operationvariablevalueslabelsvalidation_resultAutomationBinaryConditionDto
operationvariablelabelvalidation_resultAutomationBinaryConditionEmailDto
operationvariablevaluelabelAutomationBinaryConditionEmailRawDto
operationvariablevalueAutomationBinaryConditionRawDto
operationvariablevalidation_resultAutomationBinaryConditionUUIDDto
operationvariablevaluelabelAutomationBinaryConditionUUIDRawDto
operationvariablevalueAutomationConditionsDto
operationAutomationConditionsRawDto
operationAutomationNestedConditionDto
operationvalidation_resultAutomationNestedConditionRawDto
operationvalidation_resultAutomationRuleAction
AutomationRuleAssistantType
Defaults to advanced_approval
AutomationUnaryConditionBaseDto
operationvariablevalidation_resultAutomationUnaryConditionDto
operationvariablevalidation_resultBankAccountResponseDto
idworkspace_idworkspace_namenamecurrencyconnectionconnection_statusaccount_numberibanswiftBankAccountSortDto
fielddirectionBankConnectionDto
idbanktoken_expires_atBankIntegrationDto
idnamelogo_urlURL must be a valid HTTP URL
codeswiftcountry_codenational_bank_codeBankIntegrationsResponseDto
BankTransferSubscriptionResponse
BaseAccuracyFilterDto
annotations_sourceDocument source
workspace_idsWorkspace IDs
queue_idsQueue IDs
BillableFeatureDto
statusenabled_atBillableFeaturesDto
BillingCredit
idquantityunit_amountper_unitBillingCredits
allocationavailableextra_allocationextra_availabletier_credits_reset_atBillingFeatureDto
idnamekeyactiveorderavailable_in_tiersBillingHistoryDto
invoice_idinvoice_numberdateamount_duestatusBillingHistoryResponseDto
has_morenext_starting_afterprevious_ending_beforeBillingIntegrationDto
idnamekeyavailable_in_tiersorderBillingSessionCheckout
checkout_urlURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
success_urlURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
cancel_urlURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
BillingSessionCheckoutResponse
BillingUser
idnamekeyavailable_in_tiersBillingVerificationResponse
BillingWorkspace
idnamekeyavailable_in_tiersBulkAppendEmptyTableRowAnnotationDto
table_fieldactionBulkApproveDocumentsDto
queue_idsearchmessageBulkApproveOrganizationDocumentsDto
organization_idssearchmessageBulkClearTableAnnotationDto
table_fieldactionBulkDuplicateTableRowAnnotationDto
table_fieldrow_indexAnnotation table row index (0-based) to be updated
actionBulkInitiateApprovalDocumentsDto
queue_idnotify_current_approversShould be current approvers notified. Default is to notify.
searchBulkInitiateApprovalOrganizationDocumentsDto
organization_idsnotify_current_approversShould be current approvers notified. Default is to notify.
searchBulkMarkSeenAnnotationDto
fieldactionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
BulkMarkSeenTableAnnotationDto
fieldtable_fieldrow_indexAnnotation table row index (0-based) to be updated
actionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
BulkRejectDocumentsDto
queue_idrejection_reasonsearchreject_documentBulkRejectOrganizationDocumentsDto
organization_idsrejection_reasonsearchreject_documentBulkRemoveAnnotationDto
fieldactionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
BulkRemoveTableRowAnnotationDto
table_fieldrow_indexAnnotation table row index (0-based) to be updated
actionBulkUpdateAnnotationDto
fieldactionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
BulkUpdateAnnotationsAuxDto
An object of annotations changes
global_statusAnnotations global status
BulkUpdateAnnotationsResponseDto
BulkUpdateNodeAnnotationsAuxDto
An object of annotations
BulkUpdateNodeAnnotationsResponseDto
BulkUpdateTableAnnotationDto
fieldtable_fieldrow_indexAnnotation table row index (0-based) to be updated
actionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
ChangePasswordRequestDto
tokenToken used to request password change
passwordChangePasswordResponseDto
ContactIntegrationPartnerDto
emailphoneintegration_idorganization_idmessageConversationMessageDto
rolecontentCreateBankAccountDto
workspace_idcurrencynameaccount_numberibanswiftCreateBankAccountResponseDto
CreateBankConnectionResponseDto
CreateLlmExtractionRuleDto
queue_idpromptsupplier_idtargetnamesupplier_vat_idSupplier VAT id (DIČ) fallback match
supplier_tax_idSupplier tax id fallback match
supplier_nameSupplier name fallback match
CreateOrganizationDto
nameOrganization name
onboarding_preferenceCreateQueueDto
typelocalecurrencyCurrency assigned to the queue (ISO code)
nameA name of a queue
approvalWhether to use approval flow
advanced_approvalWhether to use advanced (multi-level) approval. Defaults to the value of approval. Enabling it enables approval as well.
extractionWhether to allow extraction of documents
CreateQueuesDto
CreateScheduledTaskDto
export_typeFile export type
searchexport_file_name_optionsexport_entitiesCreateStorageNodeDto
nameparent_idai_storage_strategyCreateUserRequest
emailphoneUser phone
ui_localecompanyregister_idvat_iderpinvoice_countCreateWebhookDto
urlURL must be a valid HTTP URL
entity_typeentity_idtypesignature_verificationCreateWorkspaceDto
nameregionorganization_idcompany_id_numberA valid company ID number
tax_idtax_idsvat_idintegration_idCreatedBankAccountResponseDto
idworkspace_idnamecurrencyaccount_numberibanswiftCreditsBankTransferPurchaseResponse
CreditsPurchase
checkout_urlURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
success_urlURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
cancel_urlURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
statusclient_secretCreditsPurchaseResponse
CustomerCardDto
idis_defaultcreatedbrandlast_fourexp_monthexp_yearCustomerCardsResponse
CustomerQuoteDto
expires_atsubtotaltotaltotal_vatdiscountcurrencyDashboardPaginationDto
next_documentprevious_documentpositiontotal_countDashboardPaginationResponseDto
Data
connection_statusConnection status of workspace
DateAggregationDataDto
datedate_labeldurationDeleteDocumentRegistersDto
DeleteQueueRegistersDto
queue_idDeleteRegisterRequest
typeDeltaOpMentionUserDto
indexdenotation_charvalueidtypeDemoInitializeBodyDto
localeemailphonecompanyregister_idvat_idDemoInitializeResponseDataDto
magic_linkURL must be a valid HTTP URL. Does not require a TLD and must have a protocol
DemoInitializeResponseDto
DocumentAggregationDataDto
queue_idqueue_namequeue_humanized_idworkspace_idworkspace_nameworkspace_humanized_iddocument_iddocument_page_countdurationDocumentAnnotationsDto
An object of annotations
DocumentApprovalDto
idapproval_route_idapproval_route_typeapproval_featureDocument approval status
approval_statusDocument global approval status
route_nameapproval_route_orderDocument approval order
approval_route_delegationapproval_restrictionsDocumentApprovalResponseDto
DocumentApprovalRouteDto
orderDocument approval order
delegationrestrictionsDocumentApprovalRouteResponseDto
DocumentAuditLogDto
idcreated_atdocument_ideventDocument event
new_valueprevious_valueuser_iduser_nameoriginChannel the change came through
metadataDocumentAuditLogEvent
Document event
DocumentAuditLogHumanizedDocumentDto
imported_atimported_via_emailfilenamesender_addressDocumentAuditLogHumanizedItemDto
dateoperationtextuser_idoriginChannel the change came through
DocumentAuditLogHumanizedResponseDto
array of response data
pagination
DocumentAuditLogOrigin
Channel the change came through
DocumentAuditLogResponseDto
array of response data
pagination
DocumentByPaymentStatusAggregatorResultDto
unpaidpaidpaid_partiallyto_paypayment_orderpartial_payment_orderpast_dueneeds_paymentCount of to_pay, paid_partially and partial_payment_order documents that still have a non-zero remaining amount to pay.
DocumentByStageAggregatorResultDto
to_approveto_validationlatersentdeletedrejectedspamtotalDocumentDuplicityDto
idstageDocument stage
statussourceDocument source
last_status_changed_atDate of last status change
document_urlDocument url
deletion_allowedWhether the current user is allowed to delete this document
DocumentEdiDto
providerdirectionstatusvalidation_statusdocument_typesender_identifiersender_schemereceiver_identifierreceiver_schemecounterparty_workspace_idcounterparty_workspace_nametarget_workspace_idtarget_queue_idnoteDocumentEdiStatusEnum
DocumentEditsDto
DocumentExportQueryDto
typeFile export type
export_columns_optionsexport_file_name_optionsexport_line_itemsDocumentIncludeFieldsEnum
DocumentIncludeOrganization
idhumanized_idnamestatusbillable_featuresDocumentIncludeQueue
idhumanized_idtypenameDocumentIncludeShareStatus
share_enabledshare_urlcreated_atexpires_atDocumentIncludeStorageDto
namepathparent_folder_urlDocumentIncludeWorkspace
idnameicon_colorDocumentLockStatusGetterResult
locked_atlocked_byUser who locked the document
lockedIs document locked
locked_by_current_userIs document locked by current user
locked_for_current_userIs document locked for current user
DocumentLockStatusUser
idnameemailDocumentMetadataDto
idconfidencecreated_atupdated_atqueue_idAn ID of an associated Queue
statuspage_countfile_nameextraction_errorline_items_visibilitytax_detail_visibilityemail_idinbox_statusinternal_erp_idAn internal ID from the ERP system
export_errorexport_error_descriptionmarked_as_exported_atmarked_as_exporting_atmarked_as_ready_to_export_atA 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_fromDocumentMetadataResponseDto
DocumentOcrDataResponseDto
DocumentPageEditsDto
page_indexPage index of the parent document
rotationDocumentPageImageDto
widthheightpage_numbersigned_urlmime_typeDocumentPaginationDto
next_documentprevious_documentpositiontotal_countDocumentPaginationResponseDto
DocumentShareReason
Selects the email headline and text. Defaults to plain sharing.
DocumentStageEnum
Document stage
DocumentStatusChangeWithUserType
changed_atchanged_tochanged_bytypechanged_by_idchanged_by_user_emailDocumentStatusEnum
DocumentTagDto
idnamecolorDocumentValidationStatusItem
messageseveritymessage_keydescription_keydescriptionDocumentValidationStatusResponse
DocumentWithIncludeExcludeMetadataDto
idconfidencecreated_atupdated_atqueue_idAn ID of an associated Queue
statuspage_countfile_nameextraction_errorline_items_visibilitytax_detail_visibilityemail_idinbox_statusexport_allowedapprove_allowedannotations_edit_allowedskip_alloweddeletion_allowedinitiate_approval_allowedmove_allowedreset_allowedrejection_allowedediEDI lifecycle data; null for non-EDI documents
A list of annotations values
current_approver_idsadvanced_approval_route_nameadvanced_approval_featureDocument approval status
locked_by_userDocument locked by user
lock_statusDocument lock status
current_approver_labelCurrent approver name or email
current_approver_labelsCurrent approvers name or email
stageDocument stage
rejection_reasonRejection reason
annotations_sourceDocument source
annotations_source_typelast_status_changeLast document status change
A list of document page images
received_from_nameuploaded_by_nameemail_subjectinternal_erp_idAn internal ID from the ERP system
export_errorexport_error_descriptionmarked_as_exported_atmarked_as_exporting_atmarked_as_ready_to_export_atA 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_fromqueue_featuresorganizationDocument's organization
workspaceWorkspace of document's queue
queueDocument's queue
approved_by_current_userIs document approved by current user
approval_processadvanced_approval_statusDocument global approval status
ai_instruction_processingIs an AI instruction being applied to the document (its fields should stay locked until it finishes)
payment_statusDocument payment status
document_urlDocument url
has_duplicitiesBoolean flag if document has duplicities
workspace_subject_mismatchhas_attachmentsBoolean flag if document has attachments
comments_countLast document status change
last_modified_atlast_updated_by_customer_atlast_updated_by_customer_byreceived_atfirst_page_imageshare_statusDocument's share status
advanced_approval_orderDocument approval order
partial_total_paidpartial_total_remainingstorage_locationStorage location of the document
DocumentWithNextDocumentMetadata
next_documentDocumentWithNextDocumentMetadataResponseDto
DocumentsAggregatedCounts
DocumentsApiResponse
array of response data
pagination
DocumentsCountAggregatedDto
uploadedNumber of documents to approve and to validate
sentNumber of sent documents
datedate_labelcountDeprecated, use "uploaded" instead
DocumentsCountPerQueueAggregatedDto
queue_idqueue_namequeue_humanized_iduploadedNumber of documents to approve and to validate
sentNumber of sent documents
DocumentsCountPerWorkspaceAggregatedDto
workspace_idworkspace_nameworkspace_humanized_iduploadedNumber of documents to approve and to validate
sentNumber of sent documents
DocumentsToApproveDto
A list of documents
DownloadAboPaymentRequest
document_idsbank_account_idpayment_datetypeDownloadSepaPaymentRequest
document_idsbank_account_idpayment_dateEdiCompanyDto
vat_payererp_idregister_idtax_idvat_idnamestreetcityzipcountryEdiDocumentClass
EdiDocumentCountsData
receivedreturns count of received EDI documents waiting for confirmation or rejection
issuedreturns count of issued invoices ready to be sent via EDI
processedreturns count of EDI documents which were accepted or rejected by the recipient
deletedreturns count of deleted documents in the EDI queues
allreturns count of all inbound and outbound EDI documents
EdiDocumentUnprocessedReason
returns why the document was not accepted, rejected or deleted
EdiDocumentsDecisionData
processedreturns ids of documents that were accepted, rejected or deleted
EdiInvoiceImportItemDto
document_classsimplified_tax_documentsenderrecipienttotal_basetotal_taxtotal_incl_taxtotal_roundingtotal_duedomesticityinvoice_idissue_datetaxable_supply_datedelivery_datedue_dateaccounting_datereceived_datepayment_datevat_application_datestock_datetermscurrencyvar_symconst_sympayment_typeorder_idorder_datebill_of_lading_iddescriptionnotereverse_chargeEdiLineItemDto
ordercodedescriptionquantityunit_basetotal_basetax_ratetotal_taxtotal_incl_taxreverse_chargenoteEdiPartyDto
nameregister_idtax_idvat_idvat_payerstreetcitypostcodecountrybank_accountaccount_numberbank_codeibanbicEdiPaymentType
EdiPeerWorkspaceDto
idnameregister_idtax_idvat_idstreetzipcountryEdiPeppolAccountDto
participant_idpeppol_idsext_idstatusdocument_flowactivated_atEdiSettingsDto
statusverification_statuspeppolEdiUnprocessedDocumentDto
idreasonreturns why the document was not accepted, rejected or deleted
EdiWorkspaceInvitationsDto
EditPagesDto
original_document_change_actionEmailDto
idcreated_atA datetime in ISO8601 with time zone
updated_atA datetime in ISO8601 with time zone
fromsubjectbody_plain_textbody_htmlEmailWithRolesInWorkspaceQueuesDto
emailEmbeddedAccessRequestDto
return_urlAn url to redirect after embedded document is processed
cancel_urlAn url to redirect after embedded document is cancelled
user_idAnother user id to create embedded access for
EmbeddedAccessResponseDataDto
EmbeddedAccessResponseDto
tokenembedded_urlURL must be a valid HTTP URL
return_urlURL must be a valid HTTP URL
cancel_urlURL must be a valid HTTP URL
embedded_token_user_idembedded_token_user_ui_localeEmitSseDocumentExportProgress
user_idorganization_idtypeEmitSseDocumentExtracted
queue_idtypeEmitSseNotificationReceived
user_idorganization_idtypeEnhancedDelegateDto
user_iduser_nameuser_emailEnhancedUserDto
idui_localenameemailstatuscreated_atprofile_avatar_urlEnqueueDocumentsToExtractionDto
queue_idAn ID of a queue
idsComma separated document ids
searchfiltersErpListCurrentReleaseDto
versionregionlinkrelease_notespublication_dateErpListIntegrationDto
idlogonameaccounting_systemErpListItemDto
tokenService account token
current_releaseErpListWorkspaceDto
idnameversionhumanized_idaccess_actionsExportFileNameSourceEnum
ExportOptionsDto
export_line_itemsexport_columns_optionsExternalValidationLinkDto
urlURL must be a valid HTTP URL
signature_verificationExternalValidationLinksDto
document_validationinitial_document_validationExtractionEvaluationDto
document_confidenceExtractionEvaluationFieldDto
confidencefieldvalidation_resultExtractionEvaluationResponseDto
FeatureFlagsDto
drive_uploadbank_integrationsmart_storageannotation_performance_improvementsdigitoo_ediFeatureTrialStartedResponseDto
FeatureTrialStatusOther
stateWhich "buy/trial" modal the frontend should show
FeatureTrialStatusTrialActive
stateWhich "buy/trial" modal the frontend should show
expires_atWhen the active trial expires
days_remainingDays left in the active trial (rounded down)
FieldFormattingStatus
Whether schema field should be formatted by Digitoo App UI during selection.
FilterableFieldData
keyAnnotation schema field key
messageAnnotation schema field message
filter_typeType of returned filter
FilterableFieldsResponse
FiltersQueryMetadataDto
idsComma separated document ids
stageComma separated document stage
statusComma separated document status
payment_statusComma separated document payment status
inbox_statusComma separated document inbox status
edi_statusComma separated document EDI status
edi_directionComma separated document EDI direction
last_modified_date_gtelast_modified_date_ltelast_updated_by_customer_date_gtelast_updated_by_customer_date_ltelast_status_change_at_gtelast_status_change_at_ltecreated_at_gtecreated_at_ltelast_modified_bycurrent_approver_idcurrent_approver_idsglobal_approval_statusadvanced_approval_statusapproval_statusadvanced_approval_featureDocument approval status
approval_route_usersapproval_process_usersapproved_by_usersworkspace_idorganization_idreceived_fromadvanced_approval_route_nameinternal_erp_idhas_share_linktag_idspartial_total_remaining_gtepartial_total_remaining_ltepartial_total_paid_gtepartial_total_paid_lteFioCountryCode
FioImportDomesticPaymentDto
account_fromcurrencyamountaccount_todateconstant_symbol^\d+$variable_symbol^\d+$specific_symbol^\d+$message_for_recipientcommentpayment_reasonpayment_typeFioImportInternationalPaymentDto
account_fromcurrencyamountaccount_tobic^[A-Z]{6}[A-Z0-9]{2}… · requireddatebeneficiary_namebeneficiary_streetbeneficiary_citybeneficiary_countryremittance_info1details_of_chargespayment_reasoncommentremittance_info2remittance_info3remittance_info4FioImportResponseDto
error_codestatusid_instructionsum_debetsum_creditFioImportSepaPaymentDto
account_fromcurrencyamountaccount_to^[A-Z]{2}\d{2}[A-Z0-… · requireddatebeneficiary_nameconstant_symbol^\d+$variable_symbol^\d+$specific_symbol^\d+$bic^[A-Z]{6}[A-Z0-9]{2}…commentbeneficiary_streetbeneficiary_citybeneficiary_countryremittance_info1remittance_info2remittance_info3payment_reasonpayment_typeFioPaymentTitle
GenerateAutomationRuleDto
user_promptqueue_idrule_typeDefaults to advanced_approval
GetAboPaymentDataAux
document_idpayment_statusDocument payment status
errorserror_messageseligible_to_pay_aboeligible_to_pay_qrGetAboPaymentDataResponse
GetAnnotationValuesResponseDto
A list of annotations values
GetBankAccountsResponseDto
array of response data
pagination
GetDocumentAttachmentsDto
GetDocumentDuplicitiesResponseDataDto
duplicities_countnumber of existing duplicities
List of all duplicities
GetDocumentDuplicitiesResponseDto
GetDocumentsCountAggregatedDto
GetDocumentsCountDto
GetEdiWorkspaceCompaniesDto
GetEmailAttachmentsDto
GetEmailResponseDto
GetIntegrationAgentReleasesDto
GetLineItemsTemplateDto
GetLineItemsTemplatesDto
GetLinkedAccountsResponse
GetPeppolRecipientsDto
GetRefreshTokenDto
GetSepaPaymentDataAux
document_idpayment_statusDocument payment status
errorserror_messageseligible_to_pay_sepaGetSepaPaymentDataResponse
GetStatusChangeCountsAggregatedDto
GetStatusChangeCountsDto
GetStatusHistoryCountsDto
GetSubjectDto
nameaddressstreetcitypost_codecountryGetSubjectResponse
GetTimeSpentHistoryReportResponseDto
GetTimeSpentPerDocumentReportResponseDto
GetTimeSpentPerSessionReportResponseDto
GetTimeSpentPerUnitReportResponseDto
GetTimeSpentPerUserReportResponseDto
GetTokenResponseDto
GetWorkspaceIntegrationStatusResponseDto
HighestUserRoleInOrganizationDto
organization_idorganization_humanized_idhighest_roleHubspotQuoteDto
urltotal_pricecontract_periodexpires_atImportDomesticPaymentsRequestDto
typeImportEdiIssuedInvoicesDto
ImportEdiIssuedInvoicesResponseDto
ImportFioDomesticPaymentsDto
ImportFioInternationalPaymentsDto
ImportFioSepaPaymentsDto
ImportInternationalPaymentsRequestDto
typeImportSepaPaymentsRequestDto
typeInboxDocumentCountsData
unsortedreturns count of inbox documents which were not sorted automatically
sortedreturns count of inbox documents which were sorted
spamreturns count of inbox documents which are considered spam
deletedreturns count of inbox documents which have been deleted
totalreturns count of all inbox documents
IndexStorageNodesDto
node_idsforceRe-index even when the nodes are already indexed with the current embedding model (bypasses the idempotency guard).
IndexStorageNodesResponseDto
IndexStorageNodesResultDto
indexed_file_countskipped_file_countchunk_countIndividualTierSettingsDto
included_approversincluded_workspacesincluded_usersincluded_documentsInitiateEdiConnectionDto
workspace_idsPeer workspace IDs from ERP import directory (erpImport). Mutually exclusive with tokens, token, and twoFactor.
tokensPeer EDI tokens for token mode (one or more). Mutually exclusive with workspaceIds and token/twoFactor.
tokenSingle peer EDI token for token+2FA mode. Must be sent with twoFactor.
two_factorPeer email and phone for token+2FA mode. Must be sent with token.
InitiateEdiTwoFactorDto
emailPeer workspace email for 2FA verification
phonePeer workspace phone for 2FA verification
IntegrationAgentReleasesDto
iddownload_linkURL must be a valid HTTP URL
versionnotescreated_atIntegrationConnectionStatusEnum
Connection status of workspace
IntegrationDto
idnameerp_coderegionlogoservice_urltypestatusauth_typecertificationformIntegrationLogDto
typeEvent type
messageHuman-readable message for user
document_idDocument ID reference in case an event is directly associated to the document
detailsAn object used for storing miscellaneous data related to the event and used for debugging
IntegrationPrices
monthly_contractyearly_contractbiyearly_contractIntegrationResponseDto
IntegrationSettingsDto
queue_typesalternative_titlealternative_descriptionsubtitlepartnerIntegrationSettingsPartnerDto
namelogoname_visibilityIntegrationStatusDto
erp_codeconnection_statusConnection status of workspace
global_errorIntegration error
global_error_descriptionIntegration error description
versionIntegration version
update_availableNew version of integration
tokenIntegrationStatusUpdateAvailableDto
versionNew version of integration
linkDownload link of the new integration version
IntegrationTrialStarted
expires_atWhen the newly started trial expires
IntegrationTrialStartedResponseDto
IntegrationTrialStatusOther
stateWhich "buy/trial/quote" modal the frontend should show
IntegrationTrialStatusTrialActive
stateWhich "buy/trial/quote" modal the frontend should show
expires_atWhen the active trial expires
days_remainingDays left in the active trial (rounded down)
IntegrationsResponseDto
InternalRegistersApiResponse
InviteStorageNodeExternalUserDto
external_user_emailpermissionInviteStorageNodeUserDto
user_idpermissionInvoicePreviewDto
amount_dueupcoming_invoice_amountupcoming_invoice_dateInvoicePreviewResponseDto
LastCustomerUpdateUser
idnameemailLegacyApprovalRouteUserDto
idemailnameLineItemsDataResponse
LineItemsResponseDto
LineItemsTemplate
idnameworkspace_idsender_namesender_register_idsender_tax_idLinkedAccountDto
idemailtypecreated_atLlmExtractionRulePolarity
Whether the rule extracts a value or suppresses one
LlmExtractionRuleProvenance
Who authored the rule: a user, or the learning loop (system)
LlmExtractionRuleResponseDto
idqueue_idsupplier_idsupplier_vat_idSupplier VAT id (DIČ) fallback match; null for whole-queue rules
supplier_tax_idSupplier tax id fallback match; null for whole-queue rules
supplier_nameSupplier name fallback match; null for whole-queue rules
targetnameTitle, set once on creation (GPT-generated or client-supplied)
promptprovenanceWho authored the rule: a user, or the learning loop (system)
polarityWhether the rule extracts a value or suppresses one
field_keyThe field a learned rule governs; null for user rules
source_event_countHow many corrections a learned rule was synthesised from
created_atupdated_atLlmLearningMetricResponseDto
supplier_idfield_keytotal_correctionsAll-time corrections recorded for this supplier + field
set_countCorrections that filled an empty field
change_countCorrections that changed an extracted value
remove_countCorrections that removed (forgot) a value
last_correction_athas_learned_rulerule_polarityWhether the rule extracts a value or suppresses one
rule_source_event_countCorrections the learned rule was synthesised from (0 if none)
rule_last_event_atLocalizedUserNotificationDto
idtypestatuscreated_ataction_linksmessagetask_idLockNodeStatusDto
lockedlocked_bylocked_by_current_userlocked_for_current_userlocked_atLockNodeStatusUserDto
idnameemailMagicSignInResponseDto
ManageDocumentsTagsAppendDto
operationAppend tag to documents
ManageDocumentsTagsCreateDto
operationCreate tag and append to documents
ManageDocumentsTagsRemoveDto
operationRemove tag from documents
MarkBasicAnnotationSeenInputDto
fieldAnnotation field to be updated
indexZero based index of the annotation value of a field. Mostly used for multivalue fields.
MarkSeenNodeAnnotationDto
fieldAnnotation field to be updated
actionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
MarkSeenTableAnnotationAuxDto
global_statusAnnotations global status
MarkSeenTableAnnotationResponseDto
MarkTableAnnotationSeenInputDto
fieldAnnotation field to be updated
table_keyAnnotation table to be updated
row_indexAnnotation table row index (0-based) to be updated
indexZero based index of the annotation value of a field. Mostly used for multivalue fields.
MembershipAccessActions
MembershipDto
idroleentity_identity_typeworkspace_idinclude_actionsMembershipRoleEnum
MembershipsResponseDto
MoveDocumentsDto
queue_idsearchre_extractionstatusMoveDocumentsResponseDto
affectednot_affecteddocuments_idsNewApproverGroupEntryDto
typeapproval_group_idapproval_group_policyNewApproverRouteEntryDto
typeapproval_route_idNewApproverUserEntryDto
typeuser_idNodeLockStatusResponseDto
NotificationFiltersDto
statusNotificationSettingsDto
approval_action_emailWhether to send an email when new approval for document is requested
approval_summary_emailWhether to send an email with summary of documents with requested approval
in_app_notificationsWhether to show in-app notifications
manual_email_approvalWhether to require manual approval
annotation_comment_mention_emailWhether to send an email when mentioned in an annotation comment
document_download_threshold_emailWhether to send an email when a user in the organization downloads more than 160 documents at once
NotificationSortDto
fielddirectionNotificationType
NotifyApproversSettingsEnum
Should be current approvers notified. Default is to notify.
NullableWebhookSigningKeyResponseDto
OrganizationApprovalRouteDto
idorderDocument approval order
namename_with_usersqueue_iddelegationrestrictionsqueue_nameworkspace_idworkspace_nameworkspace_icon_colorOrganizationApprovalRoutesResponseDto
OrganizationBillableFeaturesDto
enforce_features_constraintsenforce_remaining_creditsis_subscription_canceledworkspace_count_limitusers_count_limitapprovers_count_limitcontract_periodbillingtiercontract_period_started_atcontract_period_ends_attotal_paidintegrationsindividualbilling_access_block_reasonsupportbilling_credit_pools_enabledhubspot_quoteOrganizationDto
idhumanized_idnametax_idvat_idregister_idhouse_numberstreetcityzipcountrystatusinbox_statusenforce_ssosmart_storage_ai_indexing_run_started_ataccess_actionssettingsapproval_metadatafirst_queue_idinbox_queueuser_settingsbillable_featuresbilling_creditstier_product_idbilling_emailwebhook_signing_keyOrganizationErpListResponseDto
OrganizationIncludeFields
OrganizationResponseDto
OrganizationSettingsDto
OrganizationSettingsResponseDto
OrganizationStatusEnum
OrganizationUnitsCountResponseDto
OrganizationUserSettingsDto
workspace_order_byworkspace_order_directionOrganizationsResponseDto
OrganizationsUnitsCountDto
workspaces_countqueues_countcan_create_workspacecan_create_queueOutOfOfficeCreateDto
start_dateend_dateOutOfOfficeDelegationDto
delegate_to_user_idOutOfOfficeDto
iduser_idorganization_idstart_dateend_datecreated_atupdated_atOutOfOfficeQueueApproversDto
queue_idOutOfOfficeQueueApproversResponseDto
OutOfOfficeResponseDto
PageEditHistoryDto
parent_document_idedited_atedited_byPaginationDto
page_numberpage_sizetotal_countpage_counthas_previous_pagehas_next_pagePaginationQuery
numberThe page number, starting from 1
sizePartialAnnotationSchemaFieldDto
keymultivaluemessageformattingWhether schema field should be formatted by Digitoo App UI during selection.
hiddensection_message_keyseparator_keylooserequireddatatypeEntity datatype. Mandatory only for field type item.
autofillpattern_matchinghide_register_valuemultilineaccuracy_thresholdrequired_for_auto_sendfrequent_itemsnumeric_typeNumeric type for numeric fields.
max_lengthPartialAnnotationSchemaSubfieldDto
keymultivalueformattingWhether schema field should be formatted by Digitoo App UI during selection.
hiddenmessagemessage_keyrequireddatatypeEntity datatype. Mandatory only for field type item.
hide_register_valueautofillpattern_matchingaccuracy_thresholdmax_lengthPasswordChangeDto
user_localetokendifferent_password_requiredenforce_ssoPasswordChangeTokenResponseDto
PatchAccountingAutomationDto
nameactionPatchAnnotationColumnsInput
PatchAnnotationCommentDataDto
PatchAnnotationSchemaBodyDto
PatchApprovalAutomationDto
nameactionPatchDocumentApprovalActionDto
statusnotify_current_approversShould be current approvers notified. Default is to notify.
new_approvernew_approval_group_idnew_approval_group_policymessagenext_documentPatchDocumentApprovalDto
statusDocument approval status
PatchDocumentApprovalResponseDto
PatchDocumentApprovalWithNextDocumentDto
idapproval_route_idapproval_route_typeapproval_featureDocument approval status
approval_statusDocument global approval status
route_nameapproval_route_orderDocument approval order
approval_route_delegationnext_documentapproval_restrictionsPatchDocumentEdiDto
statusnew_recipientnotePatchDocumentEdiNewRecipientDto
workspacequeueTarget queue for the internal staging re-route. Omit to set an external Peppol recipient.
PatchDocumentShareStatusRequestDto
share_enabledTrue for enable, false for disable
expires_atPatchDocumentShareStatusResponseDto
PatchDocumentStatusDto
statusNew document status
internal_erp_idReturned internal document id from ERP. Applied only if new status is exported
export_errorError message from ERP. Applied only if new status is export-errored
export_error_descriptionError description from ERP. Applied only if new status is export-errored
PatchInboxStatusBodyDto
inbox_statussortpagesearchPatchInboxStatusResponseDto
PatchNotificationFiltersDto
idsstatusesPatchNotificationsStatus
statusPatchOrganizationInputDto
namevat_idtax_idregister_idhouse_numberstreetcitycountryinbox_statusbilling_emailenforce_ssozipPatchOrganizationResponseDto
PatchOrganizationWorkspaceOrderingRequest
fielddirPatchSectionVisibilityRequest
sectionvisibilityPatchSectionVisibilityResponse
PatchSectionVisibilityResponseData
sectionvisibilityPatchSetPaymentStatusBodyDto
statusDocument payment status
PatchStorageNodeColumnSettingsDto
node_idPatchStorageNodeDto
nameparent_idicon_colorinbox_hash_prefixPatchUserNotificationSettingsDto
approval_action_emailWhether to send an email when new approval for document is requested
approval_summary_emailWhether to send an email with summary of documents with requested approval
in_app_notificationsWhether to show in-app notifications
manual_email_approvalWhether to require manual approval
annotation_comment_mention_emailWhether to send an email when mentioned in an annotation comment
document_download_threshold_emailWhether to send an email when a user in the organization downloads more than 160 documents at once
PatchUserOnboardingStatusDto
originorganization_idnamephoneroleinterestscompanyregister_idvat_iderpinvoice_countPatchWorkspaceConnectionStatusDto
integration_connection_statusConnection status of workspace
global_errorGlobal error of workspace eg. connection issues
global_error_descriptionGlobal error description of workspace eg. connection issues
PatchWorkspaceDto
nameA name of the workspace
register_idtax_idtax_idsvat_idicon_color^#?([0-9A-F]{3}|[0-9…PatternMatchingDto
patternchunking_strategytransform_chunksPatternMatchingParamsDto
patternchunking_strategytransform_chunksPaymentIntentResponse
PaymentStatus
Document payment status
PeppolRecipientAddressDto
street_with_noaddress2cityregionpost_codecountry_codePeppolRecipientDto
workspace_idnameregister_idtax_idaddresspeppol_idsparticipant_idPostAccountingAutomationDto
nameactionPostAnnotationCommentBodyDto
parent_idregionPostAnnotationTableAppendRowRequestDto
table_keyPostAnnotationTableDuplicateRequestDto
table_keyindexAnnotation table row index (0-based) to be duplicated
PostAnnotationTableRemoveAllRequestDto
table_keyPostAnnotationTableRemoveRowRequestDto
table_keyindexAnnotation table row index (0-based) to be removed
PostAnnotationTableRemoveRowsRequestDto
table_keyindexesPostApprovalAutomationDto
nameactionPostApprovalRouteDto
nameorderDocument approval order
usersdelegationrestrictionsPostApprovalRouteGroupDto
approval_group_idapproval_group_policyPostBankTransferSubscriptionDto
contract_periodis_individual_tierdiscount_codePostBulkMoveDocumentsResponseDto
PostBulkPartialPaymentItem
document_idmodeamountPostBulkPartialPaymentRequest
PostBulkPaymentRequest
payment_statusDocument payment status
searchPostBulkShareLinksDto
document_idsactionexpires_atPostConnectLinkedAccountResponseDto
PostCreditsBankTransferCheckoutDto
PostCreditsSessionCheckoutDto
success_urlcancel_urlpayment_method_idPostDocumentLearnBodyDto
An object of annotations
line_items_visibilitytax_detail_visibilityPostDocumentRelearnBodyDto
nameregister_idtax_idvaluefield_keyPostDocumentWithNextDocumentDto
lock_next_documentstageDocument stage
rejection_reasonPostDocumentsStageDto
queue_idstageDocument stage
rejection_reasonsearchPostInviteUsers
PostInviteUsersResponseDto
datasuccessfully_invited_user_emailsunsuccessfully_invited_user_emailsPostInviteUsersToOrganizationBodyDto
PostInviteUsersToOrganizationMembershipDto
entity_typeentity_idroleinclude_actionsPostInviteUsersToOrganizationResponseDataDto
PostInviteUsersToOrganizationResponseDto
PostInviteUsersToOrganizationResponseErroredDto
emailreasonPostInviteUsersToOrganizationUserDto
emailPostLineItemsTemplateInput
namedocument_idPostMailDocumentSharingLinkRequestDto
emailEmail on which the share link will be sent
subjectmessagereasonSelects the email headline and text. Defaults to plain sharing.
PostQueueSetSchemaVisibilityInputDto
PostRelearnBodyDto
nameregister_idtax_idvaluefield_keyPostSessionCheckoutDto
contract_periodsuccess_urlcancel_urlis_individual_tierdiscount_codePreviewInvoiceDto
workspacesapproversPrice
idcurrencyactivetypeunit_amountmetadataPromoCodeDto
durationpercent_offamount_offcurrencyduration_in_monthsnamePromoCodeResponseDto
ProrationPreviewDataDto
prorated_amountupcoming_invoice_amountupcoming_invoice_dateProrationPreviewResponseDto
PutApprovalRouteDto
orderDocument approval order
usersdelegationrestrictionsnamePutDocumentApprovalRouteDto
orderDocument approval order
delegationrestrictionsusersPutStorageAnnotationSchemaDto
node_idPutStorageNodeQueueSyncsDto
QueueApiResponse
QueueCreationOptionsDto
typelocalecurrencyCurrency assigned to the queue (ISO code)
nameA name of a queue
approvalWhether to use approval flow
advanced_approvalWhether to use advanced (multi-level) approval. Defaults to the value of approval. Enabling it enables approval as well.
extractionWhether to allow extraction of documents
QueueDocumentsCountResponseDto
QueueFeaturesDto
extractionapprovalrelearningisdoc_extractioninvalid_invoice_detectionbounce_emailai_template_matchingai_line_items_template_matchingai_automated_accountingadvanced_approvaladvanced_approval_auto_exportaudit_logsplit_document_by_qr_codellm_extraction_headerllm_extraction_line_itemsapply_llm_learned_rulesregisters_frequent_itemsshow_to_validationdisable_approval_rejectapproval_with_noteannotation_amounts_suggestionscontext_template_matchingcontext_template_matching_line_itemsdelegate_approvalapprove_assign_approvalskip_edi_description_ai_accai_period_incrementauto_attach_email_attachmentsprioritize_international_vat_idworkspace_subject_mismatch_checkQueueIncludeFields
QueueResponseDto
QueueSettingsDto
QueueSettingsResponseDto
QueueTypeEnum
QueueUserDto
idnameemailstatusprofile_avatar_urlQueueUserReplacementDto
replacement_user_idUser who will take over the approval steps
queue_idsQueues where this replacement applies
QueueUserWithDelegatesDto
idnameemailstatusprofile_avatar_urlQueueUsersResponseDto
QueueUsersWithDelegatesResponseDto
QueueWithAnnotationSchemaDto
idhumanized_idcreated_atA datetime in ISO8601 with time zone
typeextraction_setupcurrencyworkspace_idorganization_idinbox_hashinbox_hash_prefixinboxextraction_evaluationautomation_rulesaccounting_automation_rulesextracted_pages_limitnameAn annotation schema
access_actionsdocuments_to_process_countsettingsQueue settings
featuresdocuments_countworkspaceWorkspace metadata
extraction_evaluation_rulevalidations_settingsQueuesApiResponse
A list of queues
QueuesResponseDto
QuoteProductDto
idnameorderpricerecurringquantitykeyRangeFilterApiResponse
RawAnnotationValueDto
indexraw_valueRegionDto
lefttopwidthheightpageRegisterInternalDto
idtypeinternalhide_register_valueRegisterOptionDto
labelA label that will be shown in an UI
valueA value that will be set when a user chooses this option
aliasA value that will be used to check for historical data when values change
RegistersApiResponse
RegistersInternalResponseDto
RejectEdiDocumentsDto
document_idsnoteRejection reason forwarded to the sender
RemoveApprovalImpactParamsDto
actionMust be "remove"
target_user_idUser being replaced or removed
skip_reasonReason why the user is being removed or replaced
queue_idsQueues from which the user is removed
RemoveBasicAnnotationInputDto
fieldAnnotation field to be updated
indexZero based index of the annotation value of a field. Mostly used for multivalue fields.
RemoveNodeAnnotationDto
fieldAnnotation field to be updated
actionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
ReplaceApprovalImpactParamsDto
actionMust be "replace"
target_user_idUser being replaced or removed
skip_reasonReason why the user is being removed or replaced
Replacement users per set of queues
RequestAdditionalApproversBodyDto
additional_approversNumber of additional approvers to purchase
RequestIntegrationQuoteDto
contact_emailContact email for the sales follow-up
contact_phoneContact phone number
messageFree-text message from the user
RowValidationMessageDto
table_keyrow_indexmessageScheduledTaskDto
affectednot_affectedidstatusScheduledTaskResponseDto
SearchSubjectDto
nameregistration_numbertax_numbervat_numberSepaPaymentDialogAlphanumericDataType
valueerrorsSepaPaymentDialogNumericDataType
valuenumeric_valueerrorsSepaPaymentItemData
SepaPaymentItemError
ServiceAccountTokenResponseDto
SetSchemaVisibilityResponseDto
An annotation schema
ShareStorageNodesDataDto
organization_nameShareStorageNodesResponseDto
SmartStorageAiStorageDto
strategySmartStorageBillableFeatureDto
statusenabled_atoptionsSmartStorageBillableFeatureOptionsDto
SortQuery
fieldEither 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, last_updated_by_customer_name, last_updated_by_customer_date, workspace_name, queue_name, edi_sender, edi_note)
directionStageAggregationData
stagedurationStatusChangeCountsAggregatedDto
datedate_labelcountStatusHistoryCountsPerQueueDto
queue_idqueue_namequeue_humanized_idunresolvedsentskippeddeletedStatusHistoryCountsPerWorkspaceDto
workspace_idworkspace_nameworkspace_humanized_idunresolvedsentskippeddeletedStatusHistoryTimeBucketDto
unresolvedsentskippeddeleteddatedate_labelStorageAiAssistantAnswerDto
chat_session_idmessage_idanswertable_countNumber of exportable tables in the answer, addressed by index 0..tableCount-1.
StorageAiChatConversationDto
idscope_node_idNode the thread was opened under; null for organization-wide threads.
titleupdated_atEpoch milliseconds.
created_atEpoch milliseconds.
StorageAiChatDocumentQueryDto
labelHuman label naming this result set.
totalTotal number of documents matching the query.
sortStorageAiChatDocumentQueryScopeDto
node_idStorage node the result set is scoped to; null = org-wide.
StorageAiChatDocumentQuerySortDto
fielddirectionStorageAiChatMessageResponseDto
idquestionanswertable_countNumber of exportable tables in the answer, addressed by index 0..tableCount-1.
errorStorageAiChatSessionSummaryDto
idscope_node_idNode the thread was opened under; null for organization-wide threads.
titleupdated_atEpoch milliseconds.
StorageAiChatSessionsPageDto
page_numberpage_sizetotal_countStorageAnnotationSchemaResponseDto
StorageCommentDto
idregioncreated_atupdated_atdeleted_atcreated_by_idshare_link_idshare_link_access_labeldeletion_allowedparent_idStorageCommentResponseDto
StorageCommentThreadDto
idregioncreated_atupdated_atdeleted_atcreated_by_idshare_link_idshare_link_access_labeldeletion_allowedStorageCommentThreadsResponseDto
StorageFilterableFieldDto
keyMetadata field key or annotation key, depending on the source
sourcemetadata fields are filtered via top-level filters, annotation fields via filters[annotations]
messagefilter_typeType of returned filter
StorageFilterableFieldSource
metadata fields are filtered via top-level filters, annotation fields via filters[annotations]
StorageFilterableFieldsResponseDto
StorageFilterableValuesResponseDto
StorageFolderAnnotationSchemaFieldDto
keydatatypeEntity datatype. Mandatory only for field type item.
messagemessage_keymultilinehiddenStorageFolderAnnotationSchemaFieldOptionDto
valuemessage_keylabelStorageFolderAnnotationSchemaFieldOptionResponseDto
valuelabelmessage_keyStorageFolderAnnotationSchemaFieldResponseDto
keydatatypeEntity datatype. Mandatory only for field type item.
messagecustommessage_keymultilinehiddenStorageFolderIconColor
StorageNodeAuditLogHumanizedItemDto
dateoperationtextuser_idshare_link_idStorageNodeAuditLogHumanizedResponseDto
array of response data
pagination
StorageNodeColumnDto
keyvisibilitywidthStorageNodeColumnSettingsDto
StorageNodeColumnSettingsResponseDto
StorageNodeDto
idtypenamepathdepthparent_idowner_idsize_bytesstorage_keymime_typeicon_colorsettingsinbox_hash_prefixinboxAn object of annotations
ai_indexing_statuspermissioncreated_by_idlast_updated_by_customer_idlast_updated_by_share_link_idreceived_from_emailcreated_atupdated_atai_indexed_atlast_updated_by_customer_atnavigationStorageNodeEnhancedDto
idtypenamepathdepthparent_idowner_idsize_bytesstorage_keymime_typeicon_colorsettingsinbox_hash_prefixinboxAn object of annotations
ai_indexing_statuspermissioncreated_by_idlast_updated_by_customer_idlast_updated_by_share_link_idreceived_from_emailcreated_atupdated_atowner_nameowner_emailenabled_queue_syncs_countNumber of enabled queue syncs of the folder. Always 0 for files. Null when accessed via share link.
ai_indexed_atlast_updated_by_customer_atnavigationStorageNodeFiltersQuery
owner_idnode_typecreated_atupdated_atFilters on annotation fields of the folder schema, keyed by annotation key. Kept apart from node metadata filters so an annotation key never collides with a metadata field.
StorageNodeNavigationDto
prev_node_idnext_node_idStorageNodePermissionItemResponseDto
emailpermissionStorageNodePermissionResponseDto
StorageNodeQueueDto
idhumanized_queue_idqueue_typedocument_idnameworkspace_nameStorageNodeQueueSyncDto
idqueue_idenabledStorageNodeQueueSyncsResponseDto
StorageNodeResponseDto
StorageNodeSortField
Node metadata field to sort by. Exclusive with annotation.
StorageNodeSortQuery
directionmetadataNode metadata field to sort by. Exclusive with annotation.
annotationAnnotation to sort by. Exclusive with metadata.
StorageNodeWithListColumnsDto
idtypenamepathdepthparent_idowner_idsize_bytesstorage_keymime_typeicon_colorsettingsinbox_hash_prefixinboxAn object of annotations
ai_indexing_statuspermissioncreated_by_idlast_updated_by_customer_idlast_updated_by_share_link_idreceived_from_emailcreated_atupdated_atai_indexed_atlast_updated_by_customer_atnavigationlist_columnsStorageNodesEnhancedResponseDto
StorageNodesResponseDto
StorageShareLinkAnyoneDto
typepermissionStorageShareLinkOrganizationDto
typepermissionStorageShareLinkResolveDataDto
permissionaccess_modeStorageShareLinkResolveResponseDto
StorageShareLinkResponseDto
StorageShareLinkSettingsDto
typepermissionStorageShareLinkSpecificUsersDto
typepermissionusers_emailsStripeTiersDto
StripeTiersResponseDto
SubjectSearchResultResponse
SubscriptionProductsResponseDto
TableAnnotationChangeDto
table_keyfieldrow_indexindexList of changed annotations
TagDto
idnamecolorTagResponseDto
TagUpdateDto
namecolorTagsResponseDto
TaxDetailDataResponse
TaxDetailResponseDto
ThirdPartyValidationSettingsDto
keystatusTierDto
idnameinternal_idorderincluded_usersincluded_approversincluded_workspacesincluded_documentsTierIncludedFeature
keystatushas_tooltipTimeSpentPerDocumentAggregationDto
queue_idqueue_namequeue_humanized_idworkspace_idworkspace_nameworkspace_humanized_iddocument_iddocument_page_countdurationTimeSpentPerQueueAggregationDto
queue_idqueue_namequeue_humanized_iddurationTimeSpentPerSessionAggregationDto
queue_idqueue_namequeue_humanized_idworkspace_idworkspace_nameworkspace_humanized_iduser_iduser_nameuser_emaildocument_iddocument_page_countstartendstagedurationTimeSpentPerUserAggregationDto
user_iduser_nameuser_emaildurationTimeSpentPerWorkspaceAggregationDto
workspace_idworkspace_nameworkspace_humanized_iddurationTokenResponseDto
access_tokenJWT access token
refresh_tokenJWT refresh token
expires_atrefresh_token_expires_atUpdateAnnotationAuxDto
An object of annotations changes
global_statusAnnotations global status
UpdateAnnotationGlobalStatusDto
UpdateAnnotationGlobalStatusResponseDto
UpdateAnnotationResponseDto
UpdateAnnotationSchemaDto
UpdateBasicAnnotationInputDto
fieldAnnotation field to be updated
Annotation value object to be set
indexZero based index of the annotation value of a field. Mostly used for multivalue fields.
UpdateEdiWorkspaceInvitationDto
peer_workspace_idupdate_statusUpdateExternalValidationLinkDto
typeurlURL must be a valid HTTP URL
signature_verificationUpdateLlmExtractionRuleDto
queue_idpromptsupplier_idsupplier_vat_idSupplier VAT id (DIČ) fallback match
supplier_tax_idSupplier tax id fallback match
supplier_nameSupplier name fallback match
targetnameUpdateNodeAnnotationDto
fieldAnnotation field to be updated
actionindexZero based index of the annotation value of a field. Mostly used for multivalue fields.
UpdateSubscriptionDto
workspacesapproverspayment_method_idpayment_methodUpdateTableAnnotationAuxDto
global_statusAnnotations global status
UpdateTableAnnotationInputDto
fieldAnnotation field to be updated
table_keyAnnotation table to be updated
row_indexAnnotation table row index (0-based) to be updated
Annotation value object to be set
indexZero based index of the annotation value of a field. Mostly used for multivalue fields.
UpdateTableAnnotationResponseDto
UpdateWebhookDto
urlURL must be a valid HTTP URL
signature_verificationdestination_idUpdateWorkspacesApproversDataDto
statusclient_secrethosted_invoice_urlschedule_idinvoice_numberdue_dateUpdateWorkspacesApproversDto
workspacesapproverspayment_method_idpayment_methodUpdateWorkspacesApproversResponseDto
UpdatedSubscriptionDto
statusclient_secrethosted_invoice_urlinvoice_numberdue_dateschedule_idUpdatedSubscriptionResponseDto
UpgradeRequestDto
user_iduser_nameuser_emailadditional_approversrequested_atUpgradeStatus
UploadDocumentAnnotationCommentsDataDto
regionUploadDocumentEmailDataDto
subjectbody-htmlsenderbody-plainUploadEdiWorkspaceCompaniesDto
workspace_idedi_workspace_companies_upload_methodUploadQueueRegistersDto
methodqueue_idUploadRegisterRequest
typeUserAggregationDataDto
user_iduser_nameuser_emaildurationUserApprovalStatusResponseDto
UserDto
idui_localenameemailstatusotp_statusonboarding_metadatacreated_atprofile_avatar_urlonboarding_statusUserMembershipDto
is_manageablehighest_role_in_organizationinvitation_statusis_out_of_officeUserNotificationsResponseDto
array of response data
pagination
UserOnboardingMetadataDto
phoneemailcompanyregister_idvat_iderpinvoice_countroleinterestsUserOrganizationBillableFeaturesStatusDto
commentsapprovaltwo_factor_authenticationUserOrganizationBillableFeaturesStatusResponseDto
UserOtpResponseDto
UserOtpSettingsDto
otp_secretotp_uriotp_statusotp_last_verification_dateUserReportSettingsDto
user_idorganization_idcreated_atupdated_atUserResponseDto
UserRoleManageInsertDataDto
actionroleentity_identity_typeinclude_actionsUserRoleManageResponseDto
UserRolesInWorkspaceQueues
workspace_idUserStatusChangeBreakdownDto
statuscountUserStatusChangeDto
user_iduser_nameuser_emailcountUserStatusHistoryDto
user_iduser_nameuser_emailunresolvedsentskippeddeletedUserWithDefaultOrganization
idui_localenameemailstatusotp_statusonboarding_metadatacreated_atprofile_avatar_urlonboarding_statusorganization_idworkspace_idqueue_idorganization_humanized_idworkspace_humanized_idqueue_humanized_idinternal_testerUserWithDefaultOrganizationResponseDto
UsersRoleManageBodyDto
UsersRoleManageResponseDataDto
ValidatedAnnotationsDto
An object of annotations
global_statusAnnotations global status
ValidatedAnnotationsResponseDto
ValidationKey
ValidationMessageKey
ValidationResultDto
messagemessage_keyseverityautofilled_fromvalidation_keyvalidation_timestampValueFieldFieldTagMetadata
colorValueFilterApiResponse
ValueFilterField
keylabelmetadatahide_valueVerifyOnboardingPinRequestDto
emailpin^\d{6}$ · requiredVerifyOnboardingPinResponseDto
WebhookApiResponseDto
WebhookResponseDto
identity_identity_typeurlURL must be a valid HTTP URL
signature_verificationtypeWebhookSigningKeyResponseDto
WebhookType
WebhooksApiResponseDto
WorkspaceDto
idhumanized_idnameregionregister_idtax_idtax_idsvat_idorganization_idglobal_errorglobal_error_descriptionintegration_idicon_colortypeintegration_accounting_systemedi_settingsaccess_actionsdocuments_to_process_countWorkspaceIncludeFields
WorkspaceResponseDto
WorkspaceSubjectIdMismatch
register_id_mismatchtax_id_mismatchsubject_name_mismatchWorkspaceWithTokenDto
idhumanized_idnameregionregister_idtax_idtax_idsvat_idorganization_idglobal_errorglobal_error_descriptionintegration_idicon_colortypeintegration_accounting_systemedi_settingstokenaccess_actionsdocuments_to_process_countWorkspaceWithTokenResponseDto
WorkspacesResponseDto
array of response data
pagination