Documentation | Digitoo.ai

AboPaymentDialogAlphanumericDataType

value

string | null · required

errors

AboPaymentItemError[] · required

Enum values:

missing_value

invalid_bank_account

unable_to_pay_negative_amount

unable_to_pay_zero_amount

already_paid

invalid_currency

var_sym_too_long

ValidationResultDto[] · required

AboPaymentDialogNumericDataType

value

string | null · required

numeric_value

number | null · required

errors

AboPaymentItemError[] · required

Enum values:

missing_value

invalid_bank_account

unable_to_pay_negative_amount

unable_to_pay_zero_amount

already_paid

invalid_currency

var_sym_too_long

ValidationResultDto[] · required

AboPaymentFileType

string · enum

Enum values:

ALL

KPC

PDF

AboPaymentItemData

AboPaymentDialogAlphanumericDataType · required

AboPaymentDialogNumericDataType · required

AboPaymentDialogAlphanumericDataType · 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

var_sym_too_long

AboPaymentSPD

value

string | null

error

string | null

AcceptableSettingsKeys

string · enum

Enum values:

accounting_confidence_check

adis_bank_check

adis_reliable_payer

vies

ares

AccountAutomationAnnotation

field

string · required

value

string · required

AccountAutomationAnnotationWithMetadata

field

string · required

value

string · required

label

string | null · required

AccountingAutomationDto

AutomationConditionsDto · required

id

string · uuid · required

name

string | null · required

queue_id

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

action

string · enum · required

Enum values:

apply_accounting_automation

AccountingAutomationRuleParamsWithMetadata · required

object

AccountingAutomationListResponseDto

AccountingAutomationDto[] · required

AccountingAutomationResponseDto

AccountingAutomationDto · required

AccountingAutomationRule

string · enum

Enum values:

enabled

disabled

AccountingAutomationRuleAction

string · enum

Enum values:

apply_accounting_automation

AccountingAutomationRuleParams

AccountAutomationAnnotation[] · required

AccountingAutomationRuleParamsWithMetadata

AccountAutomationAnnotationWithMetadata[] · required

AccountingAutomationRules

string · enum

Enum values:

enabled

disabled

AccountingConfidenceFieldSettingDto

key

string · required

warning_threshold

string · enum

Enum values:

DISABLED

100

90

80

70

60

50

AccountingConfidenceThreshold

string · enum

Enum values:

DISABLED

100

90

80

70

60

50

AccountingConfidenceValidationParamsDto

warning_threshold

string · enum

Enum values:

DISABLED

100

90

80

70

60

50

AccountingConfidenceFieldSettingDto[]

AccountingSystemDto

name

string · enum · required

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

credentials

string | null

AccountingSystemEnum

string · enum

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

AccuracyEntityKeyDto

entity_key

string · required

Entity key

entity_name

string · required

Entity name

accuracy

number · required

Average accuracy

AccuracyEntityTimeBucketDto

date

string · required

Period start date

date_label

string · required

Human-readable period label

AccuracyOrganizationPerEntityDto[] · required

AccuracyFilterDto

annotations_source

string · enum

Document source

Enum values:

ai

edi

none

workspace_ids

array | null

Workspace IDs

queue_ids

array | null

Queue IDs

vendors

array | null

Vendors

AccuracyOrganizationPerDocumentDto

document_id

string · uuid · required

Document ID

document_url

string · url · required

Document URL

workspace_name

string · required

Workspace name

workspace_id

string · uuid · required

Workspace ID

queue_name

string · required

Queue name

queue_id

string · uuid · required

Queue ID

accuracy

number · required

Accuracy

uploaded_at

string · date-time · required

Uploaded at

AccuracyOrganizationPerDocumentResponseDto

AccuracyOrganizationPerDocumentDto[] · required

AccuracyOrganizationPerEntityDto

workspace_id

string · uuid · required

Workspace ID

workspace_name

string · required

Workspace name

AccuracyQueueDto[] · required

AccuracyOrganizationPerEntityResponseDto

AccuracyOrganizationPerEntityDto[] · required

AccuracyEntityTimeBucketDto[]

Per-interval entity breakdown when interval query param is set

AccuracyOrganizationPerQueueDto

workspace_name

string · required

Workspace name

workspace_id

string · uuid · required

Workspace ID

queue_name

string · required

Queue name

queue_id

string · uuid · required

Queue ID

documents_count

number · required

Number of documents

average_accuracy

number · required

Average accuracy

AccuracyOrganizationPerVendorDto

vendor

string · required

Vendor

avg_accuracy

number · required

Average accuracy

AccuracyVendorWorkspaceDto[] · required

AccuracyVendorQueueDto[] · required

AccuracyOrganizationPerVendorResponseDto

AccuracyOrganizationPerVendorDto[] · required

AccuracyVendorTimeBucketDto[]

Per-interval vendor breakdown when interval query param is set

AccuracyOrganizationPerWorkspaceDto

workspace_name

string · required

Workspace name

workspace_id

string · uuid · required

Workspace ID

documents_count

number · required

Number of documents

average_accuracy

number · required

Average accuracy

AccuracyOrganizationPerQueueDto[] · required

AccuracyOrganizationPerWorkspaceResponseDto

AccuracyOrganizationPerWorkspaceDto[] · required

AccuracyWorkspaceTimeBucketDto[]

Per-interval workspace breakdown when interval query param is set

AccuracyQueueDto

queue_id

string · uuid · required

Queue ID

queue_name

string · required

Queue name

AccuracyEntityKeyDto[] · required

AccuracyTimeAggregatedDto

date

string · required

Date string

date_label

string · required

Human-readable period label (e.g. ISO week, month)

avg_accuracy

number · required

Average accuracy

AccuracyOrganizationPerWorkspaceDto[] · required

AccuracyTimeAggregatedResponseDto

AccuracyTimeAggregatedDto[] · required

AccuracyVendorQueueDto

queue_id

string · uuid · required

Queue ID

queue_name

string · required

Queue name

AccuracyVendorTimeBucketDto

date

string · required

Period start date

date_label

string · required

Human-readable period label

AccuracyOrganizationPerVendorDto[] · required

AccuracyVendorWorkspaceDto

workspace_id

string · uuid · required

Workspace ID

workspace_name

string · required

Workspace name

AccuracyWorkspaceTimeBucketDto

date

string · required

Period start date

date_label

string · required

Human-readable period label

AccuracyOrganizationPerWorkspaceDto[] · required

AddUserRoleInQueueDto

id

string · uuid · required

role

string · enum · required

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

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

affected

number · required

not_affected

number · required

AffectedEntitiesCountResponseDto

AffectedEntitiesCountDto · required

AffectedQueueDto

queue_id

string · uuid · required

Queue ID

AmountAggregateDto

sum

number · required

avg

number · required

min

number · required

max

number · required

AmountAggregatesDto

currency

string · required

AmountAggregateDto · required

count

number · required

AmountAggregatesResponseDto

AmountAggregatesDto[] · required

AnnotationCommentDto

id

string · uuid · required

object · required

created_by_id

string · uuid · required

DeltaOpDto[] · required

created_at

string · date-time · required

updated_at

string · date-time · required

deleted_at

string | null · required

deletion_allowed

boolean · required

parent_id

string | null · uuid · required

AnnotationCommentResponseDto

AnnotationCommentDto · required

AnnotationCommentThreadDto

id

string · uuid · required

object · required

created_by_id

string · uuid · required

DeltaOpDto[] · required

created_at

string · date-time · required

updated_at

string · date-time · required

deleted_at

string | null · required

deletion_allowed

boolean · required

AnnotationCommentThreadDto[] · required

AnnotationCommentThreadsResponseDto

AnnotationCommentThreadDto[] · required

AnnotationDateValueDto

value

string | null

label

string | null

usage_counter

number | null

object

raw_annotation_indices

array | null

object

array | null

probability

number | null

iso_date_value

string | null

AnnotationFieldDto

field

string · required

required

AnnotationFieldRenderOptionDto

value

string | null · required

label

string · required

label_key

string | null

AnnotationFieldRenderTypeEnum

string · enum

Enum values:

field

subtitle

separator

approval

AnnotationGlobalMessageDto

object · required

field

string | null · required

subfield

string | null · required

field_message

string | null · required

subfield_message

string | null · required

field_message_key

string | null · required

subfield_message_key

string | null · required

AnnotationGlobalStatusResponseDto

AnnotationsGlobalStatusDto · required

AnnotationNumericSuggestionDto

value

string · required

numeric_value

number · required

AnnotationNumericValueDto

value

string | null

label

string | null

usage_counter

number | null

object

raw_annotation_indices

array | null

object

array | null

probability

number | null

numeric_value

number

AnnotationNumericSuggestionDto[]

AnnotationSchemaColumnsDto

message

string · required

key

string · required

datatype

string · enum · required

Entity datatype. Mandatory only for field type item.

Enum values:

numeric

date

alphanumeric

register

visibility

string · enum · required

Enum values:

visible

hidden

width

number | null · required

AnnotationSchemaDto

type

string · enum · required

Enum values:

field

subtitle

separator

approval

message

string

Label for entity field shown in Digitoo App UI. key will be used if not provided. Mandatory only for subtitle type item.

message_key

string

Message key translation for entity field shown in Digitoo App UI. key will be used if not provided.

key

string

Entity identifier. Mandatory only for field type item.

datatype

string · enum

Entity datatype. Mandatory only for field type item.

Enum values:

numeric

date

alphanumeric

register

numeric_type

string · enum

Numeric type for numeric fields.

Enum values:

int

float

amount

Default value to apply if no value extracted by engine.

hidden

boolean

Whether an entity field should be initially hidden in UI. false will be used if not provided.

Default: false

hide_register_value

boolean

Whether an register item should have visible value in Digitoo App UI. false will be used if not provided.

Default: false

required

boolean

whether an entity field should be required to have value before exporting. false will be used if not provided.

Default:

autofill

string[]

List of entities to initiate value from engine extracted values. Does not yet work for table entity subfields.

AnnotationSchemaSubfieldsDto[]

List of entities for table entities (currently only line_items and tax_detail are supported).

multivalue

boolean

Whether an entity field should be rendered as multivalue.

Default: false

section_message_key

string | null

Adds sectionMessageKey in order to sort on

separator_key

string | null

Adds separatorKey in order to sort on

multiline

boolean | null

object

updated_by_user

boolean | null

Whether schema field has been changed in Digitoo App UI.

formatting

string · enum

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

Enum values:

enabled

disabled

max_length

number

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

AnnotationSchemaDto[] · required

AnnotationSchemaResponseDto

AnnotationSchemaResponse · required

AnnotationSchemaSubfieldsDto

key

string · required

Entity identifier. Mandatory only for field type item.

datatype

string · enum

Entity datatype. Mandatory only for field type item.

Enum values:

numeric

date

alphanumeric

register

message

string

Label for entity field shown in Digitoo App UI. key will be used if not provided. Mandatory only for subtitle type item.

hidden

boolean

Whether an entity field should be initially hidden in UI. false will be used if not provided.

Default: false

required

boolean

whether an entity field should be required to have value before exporting. false will be used if not provided.

Default:

Default value to apply if no value extracted by engine.

hide_register_value

boolean | null

Whether an register item should have visible value in Digitoo App UI. false will be used if not provided.

Default: false

object

updated_by_user

boolean | null

Whether schema field has been changed in Digitoo App UI.

formatting

string · enum

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

Enum values:

enabled

disabled

AnnotationSourceEnum

string · enum

Enum values:

ai

edi

none

Document source

AnnotationSourceFiltersDto

annotations_source

string · enum

Document source

Enum values:

ai

edi

none

AnnotationSourceType

string · enum

Enum values:

isdoc

eKasa

AnnotationTableField

string · enum

Enum values:

line_items

tax_detail

AnnotationTableRowDto

AnnotationFieldDto[] · required

ValidationResultDto[] · required

object · required

AnnotationTableValueTotalDto

field

string · required

total

number · required

AnnotationValidationMessageSeverityEnum

string · enum

Enum values:

seenByHuman

info

warning

error

AnnotationValueDto

value

string | null

label

string | null

usage_counter

number | null

object

raw_annotation_indices

array | null

object

array | null

probability

number | null

AnnotationValueInput

value

string | null · required

Annotation value string to be set

object

Position of annotation in document

raw_annotation_indices

array | null

Array of annotation indices

AnnotationsFormattingEnum

string · enum

Enum values:

regular

simplified

AnnotationsGlobalStatusDto

export_allowed

boolean · required

approve_allowed

boolean · required

annotations_edit_allowed

boolean · required

skip_allowed

boolean · required

deletion_allowed

boolean · required

initiate_approval_allowed

boolean · required

move_allowed

boolean · required

reset_allowed

boolean · required

rejection_allowed

boolean · required

object · required

ApplyApprovalImpactBodyDto

required

ApprovalAutomationDto

AutomationConditionsDto · required

id

string · uuid · required

name

string | null · required

queue_id

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

action

string · enum · required

Enum values:

assign_approval_route

assign_approvers

move_to_next_stage

required

object

ApprovalAutomationListResponseDto

ApprovalAutomationDto[] · required

ApprovalAutomationMatchDto

AutomationConditionsDto · required

id

string · uuid · required

name

string | null · required

queue_id

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

action

string · enum · required

Enum values:

assign_approval_route

assign_approvers

move_to_next_stage

required

object

approval_process

array | null

ApprovalAutomationMatchResponseDto

object · required

ApprovalAutomationResponseDto

ApprovalAutomationDto · required

ApprovalDocumentCountsData

to_approve

number · required

returns count of documents which could be approved by current user

approved

number · required

returns count of documents which had been approved by current user

rejected

number · required

returns count of documents which had been rejected

sent

number · required

returns count of documents which had been approved and sent to ERP

all

number · required

returns count of documents which had been approved by current user and has stage 'ALL'

ApprovalDocumentCountsResponseDto

object · required

response data

ApprovalGroupCreateBodyDto

name

string · required

ApprovalGroupItemBaseDto[] · minItems: 1 · required

ApprovalGroupDto

id

string · uuid · required

name

string · required

queue_id

string · uuid · required

ApprovalGroupItemDto[] · required

created_at

string · date-time · required

updated_at

string · date-time · required

deleted_at

string | null · required

ApprovalGroupItemBaseDto

user_id

string · uuid · required

ApprovalGroupItemDto

user_id

string · uuid · required

ApprovalGroupItemBaseDto[] · required

ApprovalGroupPolicy

string · enum

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

ApprovalGroupPutBodyDto

name

string · required

ApprovalGroupItemBaseDto[] · minItems: 1 · required

ApprovalGroupResponseDto

ApprovalGroupDto · required

ApprovalGroupsResponseDto

ApprovalGroupDto[] · required

ApprovalImpactResponseDto

ApprovalImpactSummaryDto · required

ApprovalImpactSummaryDto

AffectedQueueDto[] · required

Queues affected by removing or replacing this user

ApprovalOrder

string · enum

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

Document approval order

ApprovalProcessDelegateItemDto

user_id

string · uuid · required

user_name

string · required

ApprovalProcessGroupItemDto

approval_group_id

string · uuid · required

approval_group_name

string · required

approval_group_policy

string · enum · required

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

status

string · enum · required

Enum values:

approved

declined

pending

undetermined

initiated

restarted

send_back

delegated

ApprovalProcessUserItemDto[] · required

ApprovalProcessUserItemDto

user_id

string · uuid · required

name

string · required

status

string · enum · required

Enum values:

approved

declined

pending

undetermined

initiated

restarted

send_back

delegated

message

string | null · required

ApprovalProcessDelegateItemDto[] · required

ApprovalRestrictionsDto

lock_for_editing

string · enum

Enum values:

enabled

disabled

ApprovalRouteDelegateItemDto

user_id

string · uuid · required

user_email

string · email · required

user_name

string · required

ApprovalRouteDelegationEnum

string · enum

Enum values:

enabled

disabled

ApprovalRouteDto

id

string · uuid · required

order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

name

string | null · required

name_with_users

string · required

queue_id

string · uuid · required

delegation

string · enum · required

Enum values:

enabled

disabled

object · required

LegacyApprovalRouteUserDto[] · required

array · required

ApprovalRouteGroupDto

approval_group_id

string · uuid · required

approval_group_name

string · required

approval_group_policy

string · enum · required

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

ApprovalRouteUserDto[] · required

ApprovalRouteGroupPolicy

string · enum

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

ApprovalRouteLockForEditing

string · enum

Enum values:

enabled

disabled

ApprovalRouteResponseDto

ApprovalRouteDto · required

ApprovalRouteRestrictionsDto

lock_for_editing

string · enum

Enum values:

enabled

disabled

ApprovalRouteType

string · enum

Enum values:

TEMPLATE

MANUAL

ApprovalRouteUserDto

user_id

string · uuid · required

user_email

string · email · required

user_name

string · required

ApprovalRouteDelegateItemDto[] · required

ApprovalRoutesResponseDto

ApprovalRouteDto[] · required

ApprovalStatusData

approval_enabled

boolean · required

true if at least one queue has enabled approval

documents_to_approve_count

number · required

count of documents to approve

ApprovalStatusEnum

string · enum

Enum values:

approved

declined

pending

undetermined

initiated

restarted

send_back

delegated

ApprovalStatusResponseDto

object · required

response data

AttachmentDto

id

string · uuid · required

created_at

string · date-time · required

file_path

string · required

file_name

string · required

mime_type

string · required

file_size

number · required

file_size_human_readable

string · required

url

string · url · required

URL must be a valid HTTP URL

AttachmentMetadataDto · required

AttachmentLinkBodyDto

entity_id

string · uuid · required

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

customer

email

AttachmentMetadataDto

origin

string · enum · required

Enum values:

original_document

attachment

AttachmentOrigin

string · enum

Enum values:

original_document

attachment

AutomationAssignApprovalRouteParams

approval_route_id

string · uuid · required

AutomationAssignApproversParams

approvers

string[] · required

AutomationBinaryArrayConditionBaseDto

operation

string · enum · required

Enum values:

in

variable

string · required

values

string[] · required

object

AutomationBinaryArrayConditionDto

operation

string · enum · required

Enum values:

in

variable

string · required

values

string[] · required

labels

string[] · required

object

AutomationBinaryConditionDto

operation

string · enum · required

Enum values:

in

===

>

<

>=

<=

date_after

date_before

variable

string · required

required

label

string | null · required

object

AutomationBinaryConditionEmailDto

operation

string · enum · required

Enum values:

in

===

>

<

>=

<=

date_after

date_before

variable

string · required

value

string · email · required

label

string | null · required

AutomationBinaryConditionEmailRawDto

operation

string · enum · required

Enum values:

in

===

>

<

>=

<=

date_after

date_before

variable

string · required

value

string · email · required

AutomationBinaryConditionRawDto

operation

string · enum · required

Enum values:

in

===

>

<

>=

<=

date_after

date_before

variable

string · required

required

object

AutomationBinaryConditionUUIDDto

operation

string · enum · required

Enum values:

in

===

>

<

>=

<=

date_after

date_before

variable

string · required

value

string · uuid · required

label

string | null · required

AutomationBinaryConditionUUIDRawDto

operation

string · enum · required

Enum values:

in

===

>

<

>=

<=

date_after

date_before

variable

string · required

value

string · uuid · required

AutomationConditionsDto

operation

string · enum · required

Enum values:

and

or

!

!!

===

in

>

<

array · required

AutomationConditionsRawDto

operation

string · enum · required

Enum values:

and

or

!

!!

===

in

>

<

array · required

AutomationNestedConditionDto

operation

string · enum · required

Enum values:

and

or

!

array · required

object

AutomationNestedConditionRawDto

operation

string · enum · required

Enum values:

and

or

!

array · required

object

AutomationRuleAction

string · enum

Enum values:

assign_approval_route

assign_approvers

move_to_next_stage

AutomationRuleValidationResult

message_key

string · 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

operation

string · enum · required

Enum values:

!

!!

variable

string · required

object

AutomationUnaryConditionDto

operation

string · enum · required

Enum values:

!

!!

variable

string · required

object

BankAccountConnectionStatus

string · enum

Enum values:

connected

not_connected

BankAccountResponseDto

id

string · uuid · required

workspace_id

string · required

workspace_name

string · required

name

string | null · minLength: 1 · maxLength: 16 · required

currency

string · enum · required

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

Example: CZK

object · required

connection_status

string · enum · required

Enum values:

connected

not_connected

account_number

string · required

iban

string | null · required

swift

string | null · required

BankAccountSortDirection

string · enum

Enum values:

ASC

DESC

BankAccountSortDto

field

string · enum · required

Enum values:

created_at

account_number

iban

swift

currency

direction

string · enum · required

Enum values:

ASC

DESC

BankAccountSortField

string · enum

Enum values:

created_at

account_number

iban

swift

currency

BankConnectionDto

id

string · required

bank

string · enum · required

Enum values:

FIO

token_expires_at

string · required

BankIntegrationCode

string · enum

Enum values:

FIO

BankIntegrationCountryCode

string · enum

Enum values:

CZ

BankIntegrationDto

id

string · uuid · required

name

string · required

logo_url

string · url · required

URL must be a valid HTTP URL

code

string · enum · required

Enum values:

FIO

swift

string · required

country_code

string · enum · required

Enum values:

CZ

national_bank_code

string · required

BankIntegrationsResponseDto

BankIntegrationDto[] · required

BankTransferSubscription

invoice_number

string · required

due_date

string · date-time · required

BankTransferSubscriptionResponse

BankTransferSubscription · required

BaseAccuracyFilterDto

annotations_source

string · enum

Document source

Enum values:

ai

edi

none

workspace_ids

array | null

Workspace IDs

queue_ids

array | null

Queue IDs

BillableFeatureDto

status

string · enum · required

Enum values:

enabled

disabled

enabled_at

string | null

BillableFeaturesDto

BillableFeatureDto · required

BillableFeaturesStatusEnum

string · enum

Enum values:

enabled

disabled

BillableSupportDto

BillableFeatureDto · required

BillingCredit

id

string · required

quantity

number · required

unit_amount

number · required

per_unit

number · required

BillingCredits

allocation

number · required

available

number · required

extra_allocation

number · required

extra_available

number · required

tier_credits_reset_at

string | null · required

BillingFeatureDto

id

string · required

name

string · required

key

string · required

active

boolean · required

order

number · required

Prices · required

available_in_tiers

string[] · required

BillingHistoryDto

invoice_id

string · required

invoice_number

string | null · required

date

number · required

amount_due

number · required

status

string · enum · required

Enum values:

draft

open

paid

uncollectible

void

BillingHistoryResponseDto

BillingHistoryDto[] · required

has_more

boolean · required

next_starting_after

string | null · required

previous_ending_before

string | null · required

BillingHistoryStatus

string · enum

Enum values:

draft

open

paid

uncollectible

void

BillingIntegrationDto

id

string · required

name

string · required

key

string · required

IntegrationPrices · required

available_in_tiers

string[] · required

order

number · required

BillingSessionCheckout

checkout_url

string | null · url · required

URL must be a valid HTTP URL. Does not require a TLD and must have a protocol

success_url

string | null · url · required

URL must be a valid HTTP URL. Does not require a TLD and must have a protocol

cancel_url

string | null · url · required

URL must be a valid HTTP URL. Does not require a TLD and must have a protocol

BillingSessionCheckoutResponse

BillingSessionCheckout · required

BillingUser

id

string · required

name

string · required

key

string · required

Prices · required

available_in_tiers

string[] · required

BillingVerification

reason

string · required

BillingVerificationResponse

BillingVerification · required

BillingWorkspace

id

string · required

name

string · required

key

string · required

Prices · required

available_in_tiers

string[] · required

BulkAppendEmptyTableRowAnnotationDto

table_field

string · enum · required

Enum values:

line_items

tax_detail

action

string · enum · required

Enum values:

append_empty_table_row

BulkApproveDocumentsDto

object · required

queue_id

string · uuid · required

search

string | null

message

string | null

BulkApproveOrganizationDocumentsDto

object · required

organization_ids

string[] · required

search

string | null

message

string | null

BulkClearTableAnnotationDto

table_field

string · enum · required

Enum values:

line_items

tax_detail

action

string · enum · required

Enum values:

clear_table

BulkDownloadStorageNodesDto

node_ids

string[] · required

BulkDuplicateTableRowAnnotationDto

table_field

string · enum · required

Enum values:

line_items

tax_detail

row_index

number · min: 0 · required

Annotation table row index (0-based) to be updated

action

string · enum · required

Enum values:

duplicate_table_row

BulkHistoricalSyncDto

queue_sync_ids

string[] · required

BulkInitiateApprovalDocumentsDto

object · required

queue_id

string · uuid · required

notify_current_approvers

string · enum

Should be current approvers notified. Default is to notify.

Enum values:

notify

ignore

Default: notify

search

string | null

BulkInitiateApprovalOrganizationDocumentsDto

object · required

organization_ids

string[] · required

notify_current_approvers

string · enum

Should be current approvers notified. Default is to notify.

Enum values:

notify

ignore

Default: notify

search

string | null

BulkMarkSeenAnnotationDto

field

string · required

action

string · enum · required

Enum values:

mark_seen

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

BulkMarkSeenTableAnnotationDto

field

string · required

table_field

string · enum · required

Enum values:

line_items

tax_detail

row_index

number · min: 0 · required

Annotation table row index (0-based) to be updated

action

string · enum · required

Enum values:

mark_seen_table

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

BulkPurgeDocumentsDto

object · required

queue_id

string · uuid · required

search

string | null

BulkRejectDocumentsDto

object · required

queue_id

string · uuid · required

rejection_reason

string · required

search

string | null

reject_document

boolean | null

BulkRejectOrganizationDocumentsDto

object · required

organization_ids

string[] · required

rejection_reason

string · required

search

string | null

reject_document

boolean | null

BulkRemoveAnnotationDto

field

string · required

action

string · enum · required

Enum values:

remove

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

BulkRemoveTableRowAnnotationDto

table_field

string · enum · required

Enum values:

line_items

tax_detail

row_index

number · min: 0 · required

Annotation table row index (0-based) to be updated

action

string · enum · required

Enum values:

remove_table_row

BulkUpdateAnnotationDto

field

string · required

AnnotationValueInput · required

action

string · enum · required

Enum values:

update

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

BulkUpdateAnnotationsAuxDto

object | null · required

An object of annotations changes

Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}]}

RegisterChangeDto[] · required

object · required

Annotations global status

AnnotationTableValueTotalDto[] · required

array | null

BulkUpdateAnnotationsDto

array · required

BulkUpdateAnnotationsResponseDto

BulkUpdateAnnotationsAuxDto · required

BulkUpdateNodeAnnotationsAuxDto

object | null · 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}]}]}

BulkUpdateNodeAnnotationsDto

array · required

BulkUpdateNodeAnnotationsResponseDto

BulkUpdateNodeAnnotationsAuxDto · required

BulkUpdateTableAnnotationDto

field

string · required

AnnotationValueInput · required

table_field

string · enum · required

Enum values:

line_items

tax_detail

row_index

number · min: 0 · required

Annotation table row index (0-based) to be updated

action

string · enum · required

Enum values:

update_table

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

ChangePasswordRequestDto

token

string · required

Token used to request password change

password

string · required

ChangePasswordResponseDto

TokenResponseDto · required

ContactIntegrationPartnerDto

email

string · required

phone

string · required

integration_id

string · uuid · required

organization_id

string · uuid · required

message

string | null

ContractPeriod

string · enum

Enum values:

monthly

yearly

biyearly

ConversationMessageDto

content

string · maxLength: 10000 · required

role

string · enum · required

Enum values:

user

assistant

CreateBankAccountDto

currency

string · enum · required

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

workspace_id

string · uuid · required

name

string · minLength: 1 · maxLength: 16 · required

account_number

string · required

iban

string | null · required

swift

string | null · required

CreateBankAccountResponseDto

CreatedBankAccountResponseDto · required

CreateBankConnectionResponseDto

BankConnectionDto · required

CreateBankConnectionsDto

token

string · minLength: 64 · maxLength: 64 · required

CreateOrganizationDto

name

string · required

Organization name

CreatePurchaseOrderResponseDto

document_id

string · required

CreateQueueDto

type

string · enum · required

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

purchase-order

other

name

string | null · minLength: 1 · required

A name of a queue

locale

string · enum · required

Enum values:

cs

sk

en

currency

string · minLength: 1 · required

Currency assigned to the queue (ISO code)

approval

boolean | null

Whether to use approval flow

Default: false

extraction

boolean | null

Whether to allow extraction of documents

Default: true

CreateQueuesDto

QueueCreationOptionsDto[] · required

CreateScheduledTaskDto

export_type

string · enum · required

File export type

Enum values:

csv

pdf

pdf_with_isdoc

png

isdoc

xml

xlsx

SortQuery

search

string | null

export_file_name_options

ExportFileNameSourceEnum[]

Enum values:

sender_name

sender_register_id

invoice_id

internal_erp_id

original_filename

ExportOptionsDto

object

export_entities

ExportableEntity[]

Enum values:

attachments

documents

audit_logs

CreateStorageNodeDto

name

string · minLength: 1 · maxLength: 255 · required

parent_id

string | null · uuid

CreateStorageShareLinksDto

required

CreateUserRequest

email

string · email · required

phone

string · required

User phone

ui_locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

company

string | null

register_id

string | null

vat_id

string | null

erp

string | null

invoice_count

number

CreateWebhookDto

url

string · url · required

URL must be a valid HTTP URL

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

entity_id

string · uuid · required

type

string · enum

Enum values:

document_status_changed

queue_created

initial_document_validation

document_validation

Default: document_status_changed

signature_verification

string · enum

Enum values:

enabled

disabled

CreateWorkspaceDto

name

string · required

region

string · enum · required

Enum values:

cs

sk

uk

none

organization_id

string · uuid · required

AccountingSystemDto · required

QueueCreationOptionsDto[] · required

company_id_number

string | null

A valid company ID number

tax_id

string | null

tax_ids

array | null

vat_id

string | null

integration_id

string | null · uuid

CreatedBankAccountResponseDto

id

string · uuid · required

workspace_id

string · required

name

string | null · minLength: 1 · maxLength: 16 · required

currency

string · enum · required

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

Example: CZK

account_number

string · required

iban

string | null · required

swift

string | null · required

CurrencyCode

string · enum

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

CustomStripeLineItem

price

string · required

CustomWorkspaceSortItem

workspace_id

string · uuid · required

queues

string[] · required

CustomerCardDto

id

string · required

is_default

boolean · required

created

number · required

brand

string | null

last_four

string | null

exp_month

number

exp_year

number

CustomerCardsResponse

CustomerCardDto[] · required

CustomerQuoteDto

expires_at

string · date-time · required

subtotal

number · required

total

number · required

total_vat

number · required

discount

number · required

currency

string · required

QuoteProductDto[] · required

CustomerQuoteResponseDto

object · required

DashboardPaginationDto

next_document

string | null · uuid · required

previous_document

string | null · uuid · required

position

number · required

total_count

number · required

DashboardPaginationResponseDto

DashboardPaginationDto · required

Data

connection_status

string · enum · required

Connection status of workspace

Enum values:

unconnected

initial_connection_established

connection_error

connecting

DateAggregationDataDto

date

string · date-time · required

date_label

string · required

duration

number · required

UserAggregationDataDto[] · required

DeleteDocumentRegistersDto

DeleteRegisterRequest[] · required

DeleteQueueRegistersDto

DeleteRegisterRequest[] · required

queue_id

string · uuid · required

DeleteRegisterOption

value

string · required

DeleteRegisterRequest

type

string · required

DeleteRegisterOption[] · required

DeltaOpDto

required

object

DeltaOpInsertObjectDto

object

DeltaOpMentionUserDto

index

string · required

denotation_char

string · required

value

string · required

id

string · uuid · required

type

string · enum · required

Enum values:

user

DemoInitializeBodyDto

locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

email

string · email · required

phone

string · required

company

string | null · required

register_id

string | null · required

vat_id

string | null · required

DemoInitializeResponseDataDto

magic_link

string · url · required

URL must be a valid HTTP URL. Does not require a TLD and must have a protocol

DemoInitializeResponseDto

DemoInitializeResponseDataDto · required

DocumentAggregationDataDto

queue_id

string · uuid · required

queue_name

string · required

queue_humanized_id

number · required

workspace_id

string · required

workspace_name

string · required

workspace_humanized_id

number · required

document_id

string · uuid · required

document_page_count

number · required

duration

number · required

StageAggregationData[] · required

DocumentAnnotationsDto

object · required

An object of annotations

Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}],"due_date":[{"value":"01.01.2021","iso_date_value":"2021-01-01"}],"bank_account":[{"value":"123"},{"value":"456"}],"line_items":[{"activity":[{"value":"item1"}],"total_incl_tax":[{"value":"123","numeric_value":123}]},{"activity":[{"value":"item2"}],"total_incl_tax":[{"value":"456","numeric_value":456}]}]}

DocumentApprovalDto

id

string · uuid · required

approval_route_id

string | null · uuid · required

approval_route_type

string · enum · required

Enum values:

TEMPLATE

MANUAL

approval_feature

string · enum · required

Document approval status

Enum values:

enabled

disabled

array · required

approval_status

string · enum · required

Document global approval status

Enum values:

undetermined

initiated

pending

approved

declined

route_name

string | null · required

approval_route_order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

approval_route_delegation

string · enum · required

Enum values:

enabled

disabled

object

DocumentApprovalResponseDto

DocumentApprovalDto · required

DocumentApprovalRouteDto

order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

delegation

string · enum · required

Enum values:

enabled

disabled

object · required

LegacyApprovalRouteUserDto[] · required

array · required

DocumentApprovalRouteResponseDto

DocumentApprovalRouteDto · required

DocumentAuditLogDto

id

number · required

created_at

string · date-time · required

document_id

string · uuid · required

event

string · enum · required

Document event

Enum values:

document_import

document_import_via_email

document_moved

document_metadata_create

document_metadata_update

document_metadata_delete

annotation_create

annotation_update

new_value

string | null · required

previous_value

string | null · required

user_id

string · uuid · required

user_name

string · required

object · 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_at

string · date-time · required

imported_via_email

boolean · required

filename

string · required

sender_address

string | null

DocumentAuditLogHumanizedItemDto

date

string · date-time · required

operation

string · enum · required

Enum values:

update

add

delete

approval_restart

text

string · required

user_id

string · uuid · required

DocumentAuditLogHumanizedOperation

string · enum

Enum values:

update

add

delete

approval_restart

DocumentAuditLogHumanizedResponseDto

DocumentAuditLogHumanizedItemDto[] · required

array of response data

object · required

pagination

DocumentAuditLogHumanizedDocumentDto · required

DocumentAuditLogMetadataDto

field_message

string | null

row_index

number

table

string | null

DocumentAuditLogResponseDto

DocumentAuditLogDto[] · required

array of response data

object · required

pagination

DocumentByPaymentStatusAggregatorResultDto

unpaid

number · required

paid

number · required

paid_partially

number · required

to_pay

number · required

payment_order

number · required

past_due

number · required

DocumentByStageAggregatorResultDto

to_approve

number · required

to_validation

number · required

later

number · required

sent

number · required

deleted

number · required

rejected

number · required

spam

number · required

total

number · required

DocumentDuplicityDto

id

string · uuid · required

stage

string · enum · required

Document stage

Enum values:

to-validation

to-approve

later

sent

deleted

rejected

spam

none

status

string · enum · required

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

source

string · enum · required

Document source

Enum values:

ai

edi

none

last_status_changed_at

string | null · date-time · required

Date of last status change

document_url

string · required

Document url

DocumentEditsDto

DocumentPageEditsDto[] · minItems: 1 · required

DocumentExportQueryDto

type

string · enum · required

File export type

Enum values:

csv

pdf

pdf_with_isdoc

png

isdoc

xml

xlsx

export_columns_options

string · enum

Enum values:

visible

all

export_file_name_options

ExportFileNameSourceEnum[]

Enum values:

sender_name

sender_register_id

invoice_id

internal_erp_id

original_filename

export_line_items

string · enum

Enum values:

true

false

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

id

string · uuid · required

email

string · email · required

DocumentIncludeOrganization

id

string · uuid · required

humanized_id

number · required

name

string · required

status

string · enum · required

Enum values:

undetermined

demo

in_trial_period

in_grace_period

paying

disabled

free

internal

object

DocumentIncludeQueue

id

string · uuid · required

humanized_id

number · required

type

string · enum · required

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

purchase-order

other

name

string | null

DocumentIncludeShareStatus

share_enabled

boolean · required

share_url

string | null · required

created_at

string | null · required

expires_at

string | null · required

DocumentIncludeStorageDto

name

string · required

path

string · required

parent_folder_url

string | null · required

DocumentIncludeWorkspace

id

string · uuid · required

name

string · required

icon_color

string · required

DocumentLockStatusEnum

string · enum

Enum values:

LOCKED

UNLOCKED

DocumentLockStatusGetterResult

locked_at

string · date-time · required

object · required

User who locked the document

locked

boolean · required

Is document locked

locked_by_current_user

boolean · required

Is document locked by current user

locked_for_current_user

boolean · required

Is document locked for current user

DocumentLockStatusUser

id

string · uuid · required

name

string | null · required

email

string · email · required

DocumentMetadataDto

id

string · uuid · required

confidence

number | null · required

created_at

string · date-time · required

updated_at

string · date-time · required

queue_id

string · uuid · required

An ID of an associated Queue

status

string · enum · required

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

page_count

number · required

file_name

string · required

extraction_error

string | null · required

line_items_visibility

string · enum · required

Enum values:

visible

hidden

tax_detail_visibility

string · enum · required

Enum values:

visible

hidden

email_id

string | null · required

inbox_status

string · enum · required

Enum values:

sorted

unsorted

internal_erp_id

string | null

An internal ID from the ERP system

export_error

string | null

export_error_description

string | null

marked_as_exported_at

string | null

marked_as_exporting_at

string | null

marked_as_ready_to_export_at

string | 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_from

string | null

DocumentMetadataResponseDto

DocumentWithIncludeExcludeMetadataDto · required

DocumentOcrDataResponseDto

RawAnnotationValueDto[] · required

DocumentPageEditsDto

page_index

number · min: 0 · required

Page index of the parent document

rotation

number · enum

Enum values:

0

90

180

270

DocumentPageImageDto

width

number · required

height

number · required

page_number

number · required

signed_url

string · required

mime_type

string · required

DocumentPaginationDto

next_document

string | null · uuid · required

previous_document

string | null · uuid · required

position

number · required

total_count

number · required

DocumentPaginationResponseDto

DocumentPaginationDto · required

DocumentRegisterLabelDto

key

string · required

label

string · required

DocumentRegistersApiResponse

RegisterItemDto[] · required

PaginationDto · 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_at

string · date-time · required

changed_to

string · enum · required

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

changed_by

string | null · required

type

string · enum · required

Enum values:

customer

service_account

changed_by_id

string | null · required

changed_by_user_email

string | 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

DocumentTagColor

string · enum

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

DocumentTagDto

id

string · uuid · required

name

string · required

color

string · enum · required

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

DocumentTimeSpentStage

string · enum

Enum values:

to-validation

to-approve

later

DocumentValidationStatusItem

message

string | null · required

severity

string · enum · required

Enum values:

seenByHuman

info

warning

error

message_key

string · enum · required

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

description_key

string · required

description

string · required

DocumentValidationStatusResponse

DocumentValidationStatusItem[] · required

DocumentWithIncludeExcludeMetadataDto

id

string · uuid · required

confidence

number | null · required

created_at

string · date-time · required

updated_at

string · date-time · required

queue_id

string · uuid · required

An ID of an associated Queue

status

string · enum · required

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

page_count

number · required

file_name

string · required

extraction_error

string | null · required

line_items_visibility

string · enum · required

Enum values:

visible

hidden

tax_detail_visibility

string · enum · required

Enum values:

visible

hidden

email_id

string | null · required

inbox_status

string · enum · required

Enum values:

sorted

unsorted

export_allowed

boolean · required

approve_allowed

boolean · required

annotations_edit_allowed

boolean · required

skip_allowed

boolean · required

deletion_allowed

boolean · required

initiate_approval_allowed

boolean · required

move_allowed

boolean · required

reset_allowed

boolean · required

rejection_allowed

boolean · required

object · required

A list of annotations values

Example: {"invoice_id":"123","total_due":123,"due_date":"2021-01-01","bank_account":["123","456"],"line_items":[{"activity":"item1","total_incl_tax":123},{"activity":"item2","total_incl_tax":456}]}

current_approver_ids

string[] · required

advanced_approval_route_name

string | null · required

advanced_approval_feature

string · enum · required

Document approval status

Enum values:

enabled

disabled

object · required

Document locked by user

object · required

Document lock status

current_approver_label

string | null · required

Current approver name or email

current_approver_labels

string[] · required

Current approvers name or email

stage

string · enum · required

Document stage

Enum values:

to-validation

to-approve

later

sent

deleted

rejected

spam

none

rejection_reason

string | null · required

Rejection reason

annotations_source

string · enum · required

Document source

Enum values:

ai

edi

none

annotations_source_type

string · enum · required

Enum values:

isdoc

eKasa

object · required

Last document status change

DocumentPageImageDto[] · required

A list of document page images

PageEditHistoryDto[] · required

RawAnnotationValueDto[] · required

received_from_name

string | null · required

uploaded_by_name

string | null · required

email_subject

string | null · required

DocumentTagDto[] · required

internal_erp_id

string | null

An internal ID from the ERP system

export_error

string | null

export_error_description

string | null

marked_as_exported_at

string | null

marked_as_exporting_at

string | null

marked_as_ready_to_export_at

string | 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_from

string | null

object

Document's organization

object

Workspace of document's queue

object

Document's queue

approved_by_current_user

boolean | null

Is document approved by current user

approval_process

array | null

advanced_approval_status

string · enum

Document global approval status

Enum values:

undetermined

initiated

pending

approved

declined

payment_status

string · enum

Document payment status

Enum values:

paid

paid_partially

unpaid

to_pay

payment_order

past_due

document_url

string | null

Document url

has_duplicities

boolean | null

Boolean flag if document has duplicities

object

has_attachments

boolean | null

Boolean flag if document has attachments

comments_count

number

DocumentStatusChangeWithUserType[]

Last document status change

last_modified_at

string | null

last_updated_by_customer_at

string | null

object

received_at

string | null

first_page_image

string | null

object

Document's share status

advanced_approval_order

string · enum

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

partial_total_paid

number

partial_total_remaining

number

DocumentRegisterLabelDto[]

object

Storage location of the document

DocumentWithNextDocumentMetadata

DocumentMetadataDto · required

object · required

DocumentWithNextDocumentMetadataResponseDto

DocumentWithNextDocumentMetadata · required

DocumentsAggregatedCounts

DocumentByStageAggregatorResultDto · required

DocumentByPaymentStatusAggregatorResultDto · required

DocumentsApiResponse

DocumentWithIncludeExcludeMetadataDto[] · required

array of response data

object · required

pagination

DocumentsCountAggregatedDto

uploaded

number · required

Number of documents to approve and to validate

sent

number · required

Number of sent documents

date

string · date-time · required

date_label

string · required

DocumentsCountPerWorkspaceAggregatedDto[] · required

DocumentsCountPerDay

count

number · required

DocumentsCountPerQueueAggregatedDto

queue_id

string · uuid · required

queue_name

string · required

queue_humanized_id

number · required

uploaded

number · required

Number of documents to approve and to validate

sent

number · required

Number of sent documents

DocumentsCountPerWorkspaceAggregatedDto

workspace_id

string · required

workspace_name

string · required

workspace_humanized_id

number · required

uploaded

number · required

Number of documents to approve and to validate

sent

number · required

Number of sent documents

DocumentsCountPerQueueAggregatedDto[] · required

DocumentsToApproveDto

DocumentWithIncludeExcludeMetadataDto[] · required

A list of documents

DownloadAboPaymentRequest

document_ids

string[] · required

bank_account_id

string · uuid · required

payment_date

string · date-time · required

type

string · enum · required

Enum values:

ALL

KPC

PDF

PostBulkPartialPaymentItem[]

DownloadSepaPaymentRequest

document_ids

string[] · required

bank_account_id

string · uuid · required

payment_date

string · date-time · required

PostBulkPartialPaymentItem[]

EdiCompanyDto

erp_id

string | null · required

register_id

string | null · required

tax_id

string | null · required

vat_id

string | null · required

name

string | null · required

street

string | null · required

city

string | null · required

zip

string | null · required

country

string | null · required

vat_payer

boolean · required

EdiIssuedInvoiceDto

id

string · uuid · required

workspace_id

string · uuid · required

queue_id

string · uuid · required

created_at

string · date-time · required

EdiPeerWorkspaceDto

id

string · uuid · required

name

string · required

register_id

string | null · required

tax_id

string | null · required

vat_id

string | null · required

street

string | null · required

zip

string | null · required

country

string | null · required

EdiReceivedInvoiceDto

id

string · uuid · required

peer_workspace_id

string · uuid · required

recipient_workspace_id

string · uuid · required

recipient_queue_id

string · uuid · required

note

string | null · required

created_at

string · date-time · required

EdiWorkspaceInvitationDto

id

string · uuid · required

EdiPeerWorkspaceDto · required

created_at

string · date-time · required

EdiWorkspaceInvitationsDto

EdiWorkspaceInvitationDto[] · required

EditPagesDto

DocumentEditsDto[] · minItems: 1 · required

original_document_change_action

string · enum

Enum values:

keep

soft_delete

move_to_deleted

EmailDto

id

string · uuid · required

created_at

string · date-time · required

A datetime in ISO8601 with time zone

updated_at

string · date-time · required

A datetime in ISO8601 with time zone

from

string · required

subject

string · required

body_plain_text

string · required

body_html

string · required

EmailImportNotificationDto

recipient

string · email · required

EmailWithRolesInWorkspaceQueuesDto

email

string · email · required

UserRolesInWorkspaceQueues[] · required

EmbeddedAccessRequestDto

return_url

string · url

An url to redirect after embedded document is processed

cancel_url

string · url

An url to redirect after embedded document is cancelled

user_id

string | null · uuid

Another user id to create embedded access for

EmbeddedAccessResponseDataDto

EmbeddedAccessResponseDto · required

EmbeddedAccessResponseDto

token

string · required

embedded_url

string · url · required

URL must be a valid HTTP URL

return_url

string | null · url · required

URL must be a valid HTTP URL

cancel_url

string | null · url · required

URL must be a valid HTTP URL

embedded_token_user_id

string · uuid · required

embedded_token_user_ui_locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

EmitIntegrationConnectionStatusChange

workspace_id

string · uuid · required

Data · required

EmitSseDocumentExportProgress

user_id

string · uuid · required

organization_id

string · uuid · required

SseDocumentExportProgressDataDto · required

EmitSseDocumentExtracted

queue_id

string · uuid · required

SseDocumentExtractedPayloadDto · required

EmitSseNotificationReceived

user_id

string · uuid · required

organization_id

string · uuid · required

LocalizedUserNotificationDto · required

EnforceSsoEnum

string · enum

Enum values:

enabled

disabled

EnhancedDelegateDto

user_id

string · uuid · required

user_name

string · required

user_email

string · required

EnhancedUserDto

id

string · uuid · required

ui_locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

name

string | null · required

email

string · email · required

status

string · enum · required

Enum values:

initial

enabled

disabled

created_at

string · date-time · required

profile_avatar_url

string | null · required

EnqueueDocumentsToExtractionDto

queue_id

string · uuid · required

An ID of a queue

ids

array | null

Comma separated document ids

search

string

object

EnqueueToExtractionFilters

ids

array | null

Comma separated document ids

EntityTypeEnum

string · enum

Enum values:

organization

workspace

queue

document

customer

email

ErpListCurrentReleaseDto

version

string · required

region

string · required

link

string · required

release_notes

string · required

publication_date

string · date · required

ErpListIntegrationDto

id

string · uuid · required

logo

string | null · required

name

string · required

accounting_system

string · enum · required

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

ErpListItemDto

ErpListIntegrationDto · required

ErpListWorkspaceDto · required

token

string | null · required

Service account token

object · required

ErpListWorkspaceDto

id

string · uuid · required

name

string · required

version

string | null · required

humanized_id

number · required

access_actions

MembershipAccessActions[] · 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_items

boolean | null

export_columns_options

string · enum

Enum values:

visible

all

ExportableEntity

string · enum

Enum values:

attachments

documents

audit_logs

ExternalValidationLinkDto

url

string · url · required

URL must be a valid HTTP URL

signature_verification

string · enum · required

Enum values:

enabled

disabled

ExternalValidationLinksDto

object

ExternalValidationLinksResponseDto

object · 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

number · enum · required

Enum values:

50

60

70

80

90

95

99

ExtractionEvaluationFieldDto[] · required

ExtractionEvaluationFieldDto

confidence

number · enum · required

Enum values:

50

60

70

80

90

95

99

field

string · required

validation_result

string | null

ExtractionEvaluationResponseDto

ExtractionEvaluationDto · required

ExtractionLocale

string · enum

Enum values:

cs

sk

en

FailedImportSettingsDto

enabled

boolean | null

array | null

FeatureFlagsDto

drive_upload

boolean · required

bank_integration

boolean · required

smart_storage

boolean · required

annotation_performance_improvements

boolean · required

digitoo_edi

boolean · required

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

key

string · required

Annotation schema field key

message

string · required

Annotation schema field message

filter_type

string · enum · required

Type of returned filter

Enum values:

numeric

date

value

FilterableFieldsResponse

FilterableFieldData[] · required

FiltersDocumentStatusChangeDto

FiltersQueryMetadataDto

ids

array | null

Comma separated document ids

stage

DocumentStageEnum[]

Comma separated document stage

Enum values:

to-validation

to-approve

later

sent

deleted

rejected

spam

none

status

DocumentStatusEnum[]

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_status

PaymentStatus[]

Comma separated document payment status

Enum values:

paid

paid_partially

unpaid

to_pay

payment_order

past_due

inbox_status

DocumentInboxStatus[]

Comma separated document inbox status

Enum values:

sorted

unsorted

last_modified_date_gte

string | null · date-time

last_modified_date_lte

string | null · date-time

last_updated_by_customer_date_gte

string | null · date-time

last_updated_by_customer_date_lte

string | null · date-time

last_status_change_at_gte

string | null · date-time

last_status_change_at_lte

string | null · date-time

created_at_gte

string | null · date-time

created_at_lte

string | null · date-time

last_modified_by

array | null

current_approver_id

string | null · uuid

current_approver_ids

array | null

global_approval_status

AdvancedApprovalStatusEnum[]

Enum values:

undetermined

initiated

pending

approved

declined

advanced_approval_status

AdvancedApprovalStatusEnum[]

Enum values:

undetermined

initiated

pending

approved

declined

approval_status

AdvancedApprovalFeatureEnum[]

Enum values:

enabled

disabled

advanced_approval_feature

string · enum

Document approval status

Enum values:

enabled

disabled

approval_route_users

array | null

approval_process_users

array | null

approved_by_users

array | null

workspace_id

array | null

organization_id

array | null

received_from

array | null

advanced_approval_route_name

array | null

internal_erp_id

array | null

has_share_link

array | null

tag_ids

array | null

partial_total_remaining_gte

number

partial_total_remaining_lte

number

partial_total_paid_gte

number

partial_total_paid_lte

number

FioCountryCode

string · enum

Enum values:

Andorra

Spojené arabské emiráty

Afghánistán

Antigua a Barbuda

Anguilla

Albánie

Arménie

Nizozemské Antily

FioDomesticPaymentType

string · enum

Enum values:

431001

431005

431022

FioImportDomesticPaymentDto

account_from

string · minLength: 1 · maxLength: 16 · required

currency

string · enum · required

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

amount

number · min: 0.01 · max: 99999999999999.98 · required

account_to

string · required

date

string · date-time · required

constant_symbol

string | null · minLength: 1 · maxLength: 4 · pattern: /^\d+$/

variable_symbol

string | null · minLength: 1 · maxLength: 10 · pattern: /^\d+$/

specific_symbol

string | null · minLength: 1 · maxLength: 10 · pattern: /^\d+$/

message_for_recipient

string | null · maxLength: 140

comment

string | null · maxLength: 255

payment_reason

string · enum

Enum values:

Vývoz zboží

Finanční pronájem (leasing) - vývoz

Dovoz zboží

Finanční pronájem (leasing) - dovoz

Reexport

Zpracování

Opravy

Transakce z použití směnek a šeků

payment_type

string · enum

Enum values:

431001

431005

431022

FioImportInternationalPaymentDto

account_from

string · minLength: 1 · maxLength: 16 · required

currency

string · enum · required

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

amount

number · min: 0.01 · max: 99999999999999.98 · required

account_to

string · minLength: 1 · maxLength: 34 · required

bic

string · minLength: 8 · maxLength: 11 · pattern: /^[A-Z]{6}[A-Z0-9]{2… · required

date

string · date-time · required

beneficiary_name

string · minLength: 1 · maxLength: 35 · required

beneficiary_street

string · minLength: 1 · maxLength: 35 · required

beneficiary_city

string · minLength: 1 · maxLength: 35 · required

beneficiary_country

string · enum · required

Enum values:

Andorra

Spojené arabské emiráty

Afghánistán

Antigua a Barbuda

Anguilla

Albánie

Arménie

Nizozemské Antily

remittance_info1

string · maxLength: 35 · required

details_of_charges

string · enum · required

Enum values:

470501

470502

470503

payment_reason

string · enum · required

Enum values:

Vývoz zboží

Finanční pronájem (leasing) - vývoz

Dovoz zboží

Finanční pronájem (leasing) - dovoz

Reexport

Zpracování

Opravy

Transakce z použití směnek a šeků

comment

string | null · maxLength: 140

remittance_info2

string | null · maxLength: 35

remittance_info3

string | null · maxLength: 35

remittance_info4

string | null · maxLength: 35

FioImportResponseDto

error_code

number · enum · required

Enum values:

0

1

2

11

12

13

14

status

string · enum · required

Enum values:

ok

error

warning

fatal

id_instruction

number

sum_debet

number

sum_credit

number

FioImportResponseStatus

string · enum

Enum values:

ok

error

warning

fatal

FioImportSepaPaymentDto

account_from

string · minLength: 1 · maxLength: 16 · required

currency

string · enum · required

Enum values:

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

amount

number · min: 0.01 · max: 99999999999999.98 · required

account_to

string · pattern: /^[A-Z]{2}\d{2}[A-Z0… · required

date

string · date-time · required

beneficiary_name

string · minLength: 1 · maxLength: 35 · required

constant_symbol

string | null · minLength: 1 · maxLength: 4 · pattern: /^\d+$/

variable_symbol

string | null · minLength: 1 · maxLength: 10 · pattern: /^\d+$/

specific_symbol

string | null · minLength: 1 · maxLength: 10 · pattern: /^\d+$/

bic

string | null · minLength: 8 · maxLength: 11 · pattern: /^[A-Z]{6}[A-Z0-9]{2…

comment

string | null · maxLength: 140

beneficiary_street

string | null · maxLength: 35

beneficiary_city

string | null · maxLength: 35

beneficiary_country

string · enum

Enum values:

Andorra

Spojené arabské emiráty

Afghánistán

Antigua a Barbuda

Anguilla

Albánie

Arménie

Nizozemské Antily

remittance_info1

string | null · maxLength: 35

remittance_info2

string | null · maxLength: 35

remittance_info3

string | null · maxLength: 35

payment_reason

string · enum

Enum values:

Vývoz zboží

Finanční pronájem (leasing) - vývoz

Dovoz zboží

Finanční pronájem (leasing) - dovoz

Reexport

Zpracování

Opravy

Transakce z použití směnek a šeků

payment_type

string · enum

Enum values:

431008

431009

431018

FioInternationalPaymentCharges

string · enum

Enum values:

470501

470502

470503

FioPaymentResponseErrorCode

number · enum

Enum values:

0

1

2

11

12

13

14

FioPaymentTitle

string · enum

Enum values:

Vývoz zboží

Finanční pronájem (leasing) - vývoz

Dovoz zboží

Finanční pronájem (leasing) - dovoz

Reexport

Zpracování

Opravy

Transakce z použití směnek a šeků

FioSepaPaymentType

string · enum

Enum values:

431008

431009

431018

FrequentItemsDto

enabled

boolean · required

annotation

string · required

size

number · required

GenerateAutomationRuleDto

user_prompt

string · maxLength: 2000 · required

queue_id

string · uuid · required

ConversationMessageDto[]

GetAboPaymentDataAux

document_id

string · uuid · required

payment_status

string · enum · required

Document payment status

Enum values:

paid

paid_partially

unpaid

to_pay

payment_order

past_due

errors

AboPaymentItemError[] · required

Enum values:

missing_value

invalid_bank_account

unable_to_pay_negative_amount

unable_to_pay_zero_amount

already_paid

invalid_currency

var_sym_too_long

error_messages

string[] · required

eligible_to_pay_abo

boolean · required

eligible_to_pay_qr

boolean · required

AboPaymentItemData · required

AboPaymentSPD · required

GetAboPaymentDataResponse

GetAboPaymentDataAux[] · required

GetAnnotationConfidenceResponseDto

object · required

A list of annotations confidences

GetAnnotationValuesResponseDto

object · required

A list of annotations values

Example: {"invoice_id":"123","total_due":123,"due_date":"2021-01-01","bank_account":["123","456"],"line_items":[{"activity":"item1","total_incl_tax":123},{"activity":"item2","total_incl_tax":456}]}

GetBankAccountsResponseDto

BankAccountResponseDto[] · required

array of response data

object · required

pagination

GetDocumentAttachmentsDto

AttachmentDto[] · required

GetDocumentDuplicitiesResponseDataDto

duplicities_count

number · min: 0 · required

number of existing duplicities

DocumentDuplicityDto[] · required

List of all duplicities

GetDocumentDuplicitiesResponseDto

GetDocumentDuplicitiesResponseDataDto · required

GetDocumentsCountAggregatedDto

DocumentsCountAggregatedDto[] · required

GetDocumentsCountDto

DocumentsCountPerDay · required

GetEdiIssuedInvoicesDto

EdiIssuedInvoiceDto[] · required

GetEdiReceivedInvoicesDto

EdiReceivedInvoiceDto[] · required

GetEdiWorkspaceCompaniesDto

EdiCompanyDto[] · required

GetEmailAttachmentsDto

AttachmentDto[] · required

GetEmailResponseDto

EmailDto · required

GetIntegrationAgentReleasesDto

IntegrationAgentReleasesDto[] · required

GetLineItemsTemplateDto

LineItemsTemplate · required

GetLineItemsTemplatesDto

LineItemsTemplate[] · required

GetLinkedAccountsResponse

LinkedAccountDto[] · required

GetRefreshTokenDto

TokenResponseDto · required

GetSepaPaymentDataAux

document_id

string · uuid · required

payment_status

string · enum · required

Document payment status

Enum values:

paid

paid_partially

unpaid

to_pay

payment_order

past_due

errors

SepaPaymentItemError[] · 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

var_sym_too_long

error_messages

string[] · required

eligible_to_pay_sepa

boolean · required

SepaPaymentItemData · required

GetSepaPaymentDataResponse

GetSepaPaymentDataAux[] · required

GetStatusChangeCountsAggregatedDto

StatusChangeCountsAggregatedDto[] · required

GetStatusChangeCountsDto

UserStatusChangeDto[] · required

GetStatusHistoryCountsDto

StatusHistoryCountsPerWorkspaceDto[] · required

GetSubjectCountry

string · enum

Enum values:

AT

BE

BG

CY

DE

DK

EE

EL

GetSubjectDto

name

string · required

address

string · required

street

string · required

city

string · required

post_code

string · required

country

string · required

GetSubjectResponse

GetSubjectDto · required

GetTimeSpentHistoryReportResponseDto

DateAggregationDataDto[] · required

GetTimeSpentPerDocumentReportResponseDto

TimeSpentPerDocumentAggregationDto[] · required

GetTimeSpentPerSessionReportResponseDto

TimeSpentPerSessionAggregationDto[] · required

GetTimeSpentPerUnitReportResponseDto

TimeSpentPerWorkspaceAggregationDto[] · required

GetTimeSpentPerUserReportResponseDto

TimeSpentPerUserAggregationDto[] · required

GetTokenResponseDto

TokenResponseDto · required

GetUsersFromOrgExcludeUserTypes

string · enum

Enum values:

out-of-office

non-approvers

service-accounts

GetUsersFromOrgIncludeUserTypes

string · enum

Enum values:

with-deleted

GetWorkspaceIntegrationStatusResponseDto

IntegrationStatusDto · required

HighestUserRoleInOrganizationDto

organization_id

string · uuid · required

highest_role

string · enum · required

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

ImportDomesticPaymentsRequestDto

ImportFioDomesticPaymentsDto · required

type

string · enum · required

Enum values:

domestic

ImportFioDomesticPaymentsDto

FioImportDomesticPaymentDto[] · required

ImportFioInternationalPaymentsDto

FioImportInternationalPaymentDto[] · required

ImportFioPaymentsDto

required

ImportFioSepaPaymentsDto

FioImportSepaPaymentDto[] · required

ImportInternationalPaymentsRequestDto

ImportFioInternationalPaymentsDto · required

type

string · enum · required

Enum values:

international

ImportSepaPaymentsRequestDto

ImportFioSepaPaymentsDto · required

type

string · enum · required

Enum values:

sepa

InboxDocumentCountsData

unsorted

number · required

returns count of inbox documents which were not sorted automatically

sorted

number · required

returns count of inbox documents which were sorted

spam

number · required

returns count of inbox documents which are considered spam

deleted

number · required

returns count of inbox documents which have been deleted

total

number · required

returns count of all inbox documents

InboxDocumentCountsResponseDto

object · required

response data

InboxQueueDto

id

string · uuid · required

IncludeFeatureStatus

string · enum

Enum values:

enabled

disabled

IncludeFilterMetadataEnum

string · enum

Enum values:

last-status-change-user

approved-by-user

IndividualTierSettingsDto

included_approvers

number · required

included_workspaces

number · required

included_users

number · required

included_documents

number · required

InitiateEdiConnectionDto

workspace_ids

array | null · minItems: 1

Peer workspace IDs from ERP import directory (erpImport). Mutually exclusive with tokens, token, and twoFactor.

tokens

array | null · minItems: 1

Peer EDI tokens for token mode (one or more). Mutually exclusive with workspaceIds and token/twoFactor.

token

string | null

Single peer EDI token for token+2FA mode. Must be sent with twoFactor.

object

Peer email and phone for token+2FA mode. Must be sent with token.

InitiateEdiTwoFactorDto

email

string · required

Peer workspace email for 2FA verification

phone

string · required

Peer workspace phone for 2FA verification

IntegrationAgentReleasesDto

id

string · uuid · required

download_link

string · url · required

URL must be a valid HTTP URL

version

string · required

notes

string · required

created_at

string · 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

id

string · uuid · required

name

string · required

erp_code

string · enum · required

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

region

string · enum · required

Enum values:

cs

sk

uk

none

logo

string · required

service_url

string | null · url · required

type

string · enum · required

Enum values:

external

plugin

service

service_plugin

none

status

string · enum · required

Enum values:

active

coming

beta

auth_type

string · enum · required

Enum values:

oauth

token

certification

string · enum · required

Enum values:

active

pending

IntegrationSettingsDto · required

form

object · required

IntegrationLogDto

type

string · enum · required

Event type

Enum values:

debug

error

info

success

warning

message

string · required

Human-readable message for user

document_id

string · uuid

Document ID reference in case an event is directly associated to the document

details

object

An object used for storing miscellaneous data related to the event and used for debugging

IntegrationPrices

object

IntegrationResponseDto

IntegrationDto · required

IntegrationSettingsDto

queue_types

QueueTypeEnum[] · required

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

purchase-order

other

alternative_title

string | null

alternative_description

string | null

object

IntegrationSettingsPartnerDto

name

string · required

logo

string | null

name_visibility

string · enum

Enum values:

hidden

visible

IntegrationSettingsSubtitleDto

text

string · required

object

IntegrationSettingsSubtitleTootlipDto

title

string · required

subtitle

string | null

IntegrationStatus

string · enum

Enum values:

active

coming

beta

IntegrationStatusDto

erp_code

string · enum · required

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

connection_status

string · enum · required

Connection status of workspace

Enum values:

unconnected

initial_connection_established

connection_error

connecting

global_error

string | null · required

Integration error

global_error_description

string | null · required

Integration error description

version

string | null · required

Integration version

object · required

New version of integration

token

string · required

IntegrationDto · required

IntegrationStatusUpdateAvailableDto

version

string · required

New version of integration

link

string · required

Download link of the new integration version

IntegrationType

string · enum

Enum values:

external

plugin

service

service_plugin

none

IntegrationsResponseDto

IntegrationDto[] · required

InternalRegistersApiResponse

RegisterItemDto[] · required

PaginationDto · required

InvitationStatusEnum

string · enum

Enum values:

expired

active

InviteStorageNodeExternalUserDto

external_user_email

string · email · required

permission

string · enum · required

Enum values:

viewer

editor

InviteStorageNodeUserDto

user_id

string · uuid · required

permission

string · enum · required

Enum values:

viewer

editor

owner

InvoicePreviewDto

amount_due

number · required

InvoicePreviewResponseDto

InvoicePreviewDto · required

LastCustomerUpdateUser

id

string | null · uuid · required

name

string | null · required

email

string | null · required

LegacyApprovalRouteUserDto

id

string · uuid · required

email

string · email · required

name

string · required

LineItemsDataResponse

AnnotationTableRowDto[] · required

AnnotationTableValueTotalDto[] · required

LineItemsResponseDto

LineItemsDataResponse · required

PaginationDto · required

LineItemsRestorationSource

string · enum

Enum values:

original

after_initial_validation

LineItemsTemplate

id

string · uuid · required

name

string · required

workspace_id

string | null · uuid · required

sender_name

string | null · required

sender_register_id

string | null · required

sender_tax_id

string | null · required

LinkedAccountDto

id

string · uuid · required

email

string · required

type

string · enum · required

Enum values:

google

microsoft

created_at

string · date-time · required

LinkedSocialAccountType

string · enum

Enum values:

google

microsoft

LocalizedUserNotificationDto

id

string · uuid · required

type

string · enum · required

Enum values:

document_export

annotation_comment_mention

annotation_comment_reply

upgrade_approvers_request

edi_invitation

status

string · enum · required

Enum values:

seen

unseen

dismissed

created_at

string · date-time · required

action_links

string[] · required

message

string · required

LockNodeStatusDto

locked

boolean · required

object · required

locked_by_current_user

boolean · required

locked_for_current_user

boolean · required

locked_at

string | null · date-time

LockNodeStatusUserDto

id

string · uuid · required

name

string | null · required

email

string · required

LockStatusRequestDto

lock_status

string · enum · required

Enum values:

LOCKED

UNLOCKED

LockStatusResponseDataDto

object · required

Document lock status

LogTypeEnum

string · enum

Enum values:

debug

error

info

success

warning

Event type

LoginRequestDto

email

string · email · required

password

string · required

MagicSignInRequestDto

token

string · required

MagicSignInResponseDto

TokenResponseDto · required

ManageDocumentsTagsAppendDto

operation

string · enum · required

Append tag to documents

Enum values:

append

ManageDocumentsTagsTagIdDto · required

ManageDocumentsTagsBodyDto

document_ids

string[] · required

required

ManageDocumentsTagsCreateDto

operation

string · enum · required

Create tag and append to documents

Enum values:

create

ManageDocumentsTagsTagNameDto · required

ManageDocumentsTagsRemoveDto

operation

string · enum · required

Remove tag from documents

Enum values:

remove

ManageDocumentsTagsTagIdDto · required

ManageDocumentsTagsTagIdDto

id

string · uuid · required

ManageDocumentsTagsTagNameDto

name

string · required

ManagePasswordResetDto

user_id

string · uuid · required

ManageUserSchemaDto

user_ids

string[] · required

queue_ids

string[] · required

ManageUserSchemaFieldsDto[] · required

ManageUserSchemaFieldsDto

field_key

string · required

hidden

boolean · required

MarkBasicAnnotationSeenInputDto

field

string · required

Annotation field to be updated

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

MarkSeenNodeAnnotationDto

field

string · required

Annotation field to be updated

action

string · enum · required

Enum values:

mark_seen

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

MarkSeenTableAnnotationAuxDto

TableAnnotationChangeDto[] · required

RegisterChangeDto[] · required

object · required

Annotations global status

MarkSeenTableAnnotationResponseDto

MarkSeenTableAnnotationAuxDto · required

MarkTableAnnotationSeenInputDto

field

string · required

Annotation field to be updated

table_key

string · enum · required

Annotation table to be updated

Enum values:

line_items

tax_detail

row_index

number · min: 0 · required

Annotation table row index (0-based) to be updated

index

number · 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

id

string · uuid · required

role

string · enum · required

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

entity_id

string · uuid · required

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

customer

email

workspace_id

string | null · uuid

include_actions

MembershipAccessActions[]

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

MembershipResponseDto

UserMembershipDto[] · required

WorkspaceDto[] · required

QueueWithAnnotationSchemaDto[] · required

MembershipRoleEnum

string · enum

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

MembershipsResponseDto

MembershipResponseDto · required

MoveDocumentsDto

queue_id

string · uuid · required

object

SortQuery

PaginationQuery

search

string | null

re_extraction

string · enum

Enum values:

enabled

disabled

status

string · enum

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

MoveDocumentsResponseDto

affected

number · required

not_affected

number · required

documents_ids

string[] · required

NewApproverGroupEntryDto

type

string · enum · required

Enum values:

user

group

route

approval_group_id

string · uuid · required

approval_group_policy

string · enum · required

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

NewApproverRouteEntryDto

type

string · enum · required

Enum values:

user

group

route

approval_route_id

string · uuid · required

NewApproverTypeEnum

string · enum

Enum values:

user

group

route

NewApproverUserEntryDto

type

string · enum · required

Enum values:

user

group

route

user_id

string · uuid · required

NodeIncludeFieldsEnum

string · enum

Enum values:

navigation

folder_annotation_schema

NodeLockStatusEnum

string · enum

Enum values:

LOCKED

UNLOCKED

NodeLockStatusRequestDto

lock_status

string · enum · required

Enum values:

LOCKED

UNLOCKED

NodeLockStatusResponseDto

LockNodeStatusDto · required

NodePermission

string · enum

Enum values:

viewer

editor

owner

NotificationFiltersDto

status

NotificationStatus[]

Enum values:

seen

unseen

dismissed

NotificationSettingsDto

approval_action_email

boolean · required

Whether to send an email when new approval for document is requested

approval_summary_email

boolean · required

Whether to send an email with summary of documents with requested approval

in_app_notifications

boolean · required

Whether to show in-app notifications

manual_email_approval

boolean · required

Whether to require manual approval

annotation_comment_mention_email

boolean · required

Whether to send an email when mentioned in an annotation comment

NotificationSortDirection

string · enum

Enum values:

ASC

DESC

NotificationSortDto

field

string · enum · required

Enum values:

created_at

direction

string · enum · required

Enum values:

ASC

DESC

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

annotation_comment_reply

upgrade_approvers_request

edi_invitation

NotifyApproversSettingsEnum

string · enum

Enum values:

notify

ignore

Should be current approvers notified. Default is to notify.

NullableWebhookSigningKeyDto

webhook_signing_key

string | null · required

NullableWebhookSigningKeyResponseDto

NullableWebhookSigningKeyDto · required

OnboardingOrigin

string · enum

Enum values:

DEMO

REGISTRATION

OrganizationApprovalRouteDto

id

string · uuid · required

order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

name

string | null · required

name_with_users

string · required

queue_id

string · uuid · required

delegation

string · enum · required

Enum values:

enabled

disabled

object · required

LegacyApprovalRouteUserDto[] · required

array · required

queue_name

string · required

workspace_id

string · uuid · required

workspace_name

string · required

workspace_icon_color

string · required

OrganizationApprovalRoutesResponseDto

OrganizationApprovalRouteDto[] · required

OrganizationBillableFeaturesDto

enforce_features_constraints

boolean · required

enforce_remaining_credits

boolean · required

is_subscription_canceled

boolean · required

workspace_count_limit

number · required

users_count_limit

number · required

approvers_count_limit

number · required

contract_period

string · enum · required

Enum values:

monthly

yearly

biyearly

billing

boolean · required

tier

string · enum · required

Enum values:

trial

tier_1

tier_2

tier_3

individual

temp_individual

contract_period_started_at

string | null · required

contract_period_ends_at

string | null · required

total_paid

number | null · required

BillableFeaturesDto · required

integrations

string[] · required

object · required

object

UpgradeRequestDto[]

billing_credit_pools_enabled

boolean | null

OrganizationDto

id

string · uuid · required

humanized_id

number · required

name

string · required

tax_id

string | null · required

vat_id

string | null · required

register_id

string | null · required

house_number

string | null · required

street

string | null · required

city

string | null · required

zip

string | null · required

country

string | null · required

status

string · enum · required

Enum values:

undetermined

demo

in_trial_period

in_grace_period

paying

disabled

free

internal

inbox_status

string · enum · required

Enum values:

enabled

disabled

enforce_sso

string · enum · required

Enum values:

enabled

disabled

access_actions

MembershipAccessActions[]

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

object

first_queue_id

number | null

object

billing_email

string | null

OrganizationSettingsDto

OrganizationUserSettingsDto

webhook_signing_key

object | null

OrganizationErpListResponseDto

ErpListItemDto[] · 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

OrganizationDto · required

OrganizationSettingsDto

AnnotationSchemaColumnsDto[] · required

AnnotationSchemaDto[] · required

OrganizationSettingsResponseDto

OrganizationSettingsDto · required

OrganizationStatusEnum

string · enum

Enum values:

undetermined

demo

in_trial_period

in_grace_period

paying

disabled

free

internal

OrganizationUnitsCountResponseDto

OrganizationsUnitsCountDto · required

OrganizationUserSettingsDto

workspace_order_by

string · enum · required

Enum values:

name

createdAt

ordering

workspace_order_direction

string · enum · required

Enum values:

asc

desc

OrganizationsResponseDto

OrganizationDto[] · required

OrganizationsUnitsCountDto

workspaces_count

number · required

queues_count

number · required

can_create_workspace

boolean · required

can_create_queue

boolean · required

OriginalDocumentChangeActionStrategy

string · enum

Enum values:

keep

soft_delete

move_to_deleted

OtpStatus

string · enum

Enum values:

disabled

unverified

enabled

OutOfOfficeCreateDto

start_date

string · date-time · required

end_date

string | null · required

OutOfOfficeDelegationDto · required

OutOfOfficeDelegationDto

delegate_to_user_id

string · uuid · required

OutOfOfficeQueueOverrideDto[] · required

OutOfOfficeDto

id

string · uuid · required

user_id

string · uuid · required

organization_id

string · uuid · required

start_date

string · date-time · required

end_date

string | null · required

created_at

string · date-time · required

updated_at

string · date-time · required

OutOfOfficeDelegationDto · required

OutOfOfficeGetResponseDto

object · required

OutOfOfficeQueueOverrideDto

queue_ids

string[] · required

user_id

string · uuid · required

OutOfOfficeResponseDto

OutOfOfficeDto · required

OutOfOfficeUpdateDto

start_date

string · date-time

end_date

string | null

OutOfOfficeDelegationDto

PageEditHistoryDto

DocumentPageEditsDto[] · minItems: 1 · required

parent_document_id

string · uuid · required

edited_at

string · date-time · required

edited_by

string · uuid · required

PaginationDto

page_number

number · required

page_size

number · required

total_count

number · required

page_count

number · required

has_previous_page

boolean · required

has_next_page

boolean · required

PaginationQuery

number

number · min: 1

The page number, starting from 1

Default: 1

size

number · min: 1 · max: 1000

PartialAnnotationSchemaFieldDto

key

string | null

AnnotationFieldRenderOptionDto[]

multivalue

boolean | null

message

string | null

formatting

string · enum

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

Enum values:

enabled

disabled

hidden

boolean | null

PartialAnnotationSchemaSubfieldDto[]

section_message_key

string | null

separator_key

string | null

loose

boolean | null

required

boolean

datatype

string · enum

Entity datatype. Mandatory only for field type item.

Enum values:

numeric

date

alphanumeric

register

autofill

array | null

object

hide_register_value

boolean | null

multiline

boolean | null

accuracy_threshold

number

required_for_auto_send

boolean | null

object

numeric_type

string · enum

Numeric type for numeric fields.

Enum values:

int

float

amount

max_length

number

PartialAnnotationSchemaSubfieldDto

key

string · required

multivalue

boolean | null

formatting

string · enum

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

Enum values:

enabled

disabled

hidden

boolean | null

message

string | null

message_key

string | null

required

boolean

datatype

string · enum

Entity datatype. Mandatory only for field type item.

Enum values:

numeric

date

alphanumeric

register

hide_register_value

boolean | null

autofill

array | null

object

accuracy_threshold

number

max_length

number

PartialPaymentMode

string · enum

Enum values:

add

set

PartnerNameVisibility

string · enum

Enum values:

hidden

visible

PasswordChangeDto

user_locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

token

string · required

different_password_required

boolean · required

enforce_sso

boolean · required

PasswordChangeTokenResponseDto

PasswordChangeDto · required

PatchAccountingAutomationDto

name

string | null

action

string · enum

Enum values:

apply_accounting_automation

AccountingAutomationRuleParams

AutomationConditionsRawDto

PatchAnnotationColumnItem

key

string · required

visibility

boolean · required

width

number | null

PatchAnnotationColumnsInput

PatchAnnotationColumnItem[] · required

PatchAnnotationCommentDataDto

DeltaOpDto[] · minItems: 1 · required

PatchAnnotationSchemaBodyDto

PartialAnnotationSchemaFieldDto[] · required

PatchApprovalAutomationDto

name

string | null

action

string · enum

Enum values:

assign_approval_route

assign_approvers

move_to_next_stage

AutomationConditionsRawDto

PatchDocumentApprovalActionDto

status

string · enum · required

Enum values:

approved

declined

pending

undetermined

initiated

restarted

send_back

delegated

notify_current_approvers

string · enum

Should be current approvers notified. Default is to notify.

Enum values:

notify

ignore

Default: notify

new_approver

string | null

new_approval_group_id

string | null · uuid

new_approval_group_policy

string · enum

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

array

message

string | null

object

PatchDocumentApprovalDto

status

string · enum · required

Document approval status

Enum values:

enabled

disabled

PatchDocumentApprovalResponseDto

PatchDocumentApprovalWithNextDocumentDto · required

PatchDocumentApprovalRouteDto

approval_route_id

string | null · uuid · required

PatchDocumentApprovalWithNextDocumentDto

id

string · uuid · required

approval_route_id

string | null · uuid · required

approval_route_type

string · enum · required

Enum values:

TEMPLATE

MANUAL

approval_feature

string · enum · required

Document approval status

Enum values:

enabled

disabled

array · required

approval_status

string · enum · required

Document global approval status

Enum values:

undetermined

initiated

pending

approved

declined

route_name

string | null · required

approval_route_order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

approval_route_delegation

string · enum · required

Enum values:

enabled

disabled

next_document

string | null · uuid · required

object

PatchDocumentEdiDto

status

string · enum

Enum values:

accept

reject

object

note

string | null

PatchDocumentEdiNewRecipientDto

workspace

string · uuid · required

queue

string · uuid · required

PatchDocumentEdiStatusEnum

string · enum

Enum values:

accept

reject

PatchDocumentShareStatusRequestDto

share_enabled

boolean · required

True for enable, false for disable

expires_at

string | null · date-time

PatchDocumentShareStatusResponseDto

DocumentIncludeShareStatus · required

PatchDocumentStatusDto

status

string · enum · required

New document status

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

internal_erp_id

string | null

Returned internal document id from ERP. Applied only if new status is exported

export_error

string | null

Error message from ERP. Applied only if new status is export-errored

export_error_description

string | null

Error description from ERP. Applied only if new status is export-errored

PatchInboxStatusBodyDto

inbox_status

string · enum · required

Enum values:

sorted

unsorted

object

search

string | null

PatchInboxStatusResponseDataDto

affected

number · required

not_affected

number · required

PatchInboxStatusResponseDto

PatchInboxStatusResponseDataDto · required

PatchInternalErpIdDto

internal_erp_id

string | null · required

PatchLineItemsTemplateInput

name

string · maxLength: 100 · required

PatchNextDocumentDto

object

search

string | null

PatchNotificationFiltersDto

ids

string[]

statuses

NotificationStatus[]

Enum values:

seen

unseen

dismissed

PatchNotificationsStatus

PatchNotificationFiltersDto · required

status

string · enum · required

Enum values:

seen

unseen

dismissed

PatchOrganizationInputDto

name

string

vat_id

string | null

tax_id

string | null

register_id

string | null

house_number

string | null

street

string | null

city

string | null

country

string

inbox_status

string · enum

Enum values:

enabled

disabled

billing_email

string | null

enforce_sso

string · enum

Enum values:

enabled

disabled

zip

string

PatchOrganizationResponseDto

OrganizationDto · required

PatchOrganizationWorkspaceOrderingRequest

field

string · enum · required

Enum values:

name

createdAt

ordering

dir

string · enum · required

Enum values:

asc

desc

CustomWorkspaceSortItem[]

PatchPushTokenStatusDto

status

string · enum · required

Enum values:

enabled

paused

expired

PatchQueueAccountingAutomationDto

status

string · enum · required

Enum values:

enabled

disabled

PatchQueueAutomationRulesDto

status

string · enum · required

Enum values:

enabled

disabled

PatchQueueDto

name

string | null

inbox_hash_prefix

string

PatchQueueExtractionEvaluationDto

status

string · enum · required

Enum values:

enabled

disabled

PatchSectionVisibilityRequest

section

string · enum · required

Enum values:

line-items

tax-details

visibility

string · enum · required

Enum values:

visible

hidden

PatchSectionVisibilityResponse

PatchSectionVisibilityResponseData · required

PatchSectionVisibilityResponseData

section

string · enum · required

Enum values:

line-items

tax-details

visibility

string · enum · required

Enum values:

visible

hidden

PatchSetPaymentStatusBodyDto

status

string · enum · required

Document payment status

Enum values:

paid

paid_partially

unpaid

to_pay

payment_order

past_due

PatchStorageNodeDto

name

string · minLength: 1 · maxLength: 255

parent_id

string | null · uuid

icon_color

string · enum

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

inbox_hash_prefix

string

PatchUserLanguageRegionDto

ui_locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

PatchUserNameDto

name

string | null

PatchUserNotificationSettingsDto

approval_action_email

boolean

Whether to send an email when new approval for document is requested

approval_summary_email

boolean

Whether to send an email with summary of documents with requested approval

in_app_notifications

boolean

Whether to show in-app notifications

manual_email_approval

boolean

Whether to require manual approval

annotation_comment_mention_email

boolean

Whether to send an email when mentioned in an annotation comment

PatchUserOnboardingStatusDto

origin

string · enum · required

Enum values:

DEMO

REGISTRATION

organization_id

string · uuid · required

name

string · required

phone

string · required

role

string · required

company

string · required

register_id

string · required

vat_id

string · required

erp

string · required

invoice_count

number · required

PatchWorkspaceConnectionStatusDto

integration_connection_status

string · enum · required

Connection status of workspace

Enum values:

unconnected

initial_connection_established

connection_error

connecting

global_error

string

Global error of workspace eg. connection issues

global_error_description

string | null

Global error description of workspace eg. connection issues

PatchWorkspaceDto

name

string | null · minLength: 1

A name of the workspace

register_id

string | null

tax_id

string | null

tax_ids

array | null

vat_id

string | null

icon_color

string | null · pattern: ^#?([0-9A-F]{3}|[0-9…

PatternMatchingChunkingStrategy

string · enum

Enum values:

ALL

EACH

PatternMatchingDto

pattern

string · required

chunking_strategy

string · enum

Enum values:

ALL

EACH

transform_chunks

array | null

PatternMatchingParamsDto

pattern

string · required

chunking_strategy

string · enum · required

Enum values:

ALL

EACH

transform_chunks

string[]

PaymentIntentDto

client_secret

string · required

PaymentIntentResponse

PaymentIntentDto · required

PaymentStatus

string · enum

Enum values:

paid

paid_partially

unpaid

to_pay

payment_order

past_due

Document payment status

PostAccountingAutomationDto

name

string | null · required

action

string · enum · required

Enum values:

apply_accounting_automation

AccountingAutomationRuleParams · required

AutomationConditionsRawDto · required

PostAnnotationCommentBodyDto

DeltaOpDto[] · minItems: 1 · required

parent_id

string | null · uuid

object

PostAnnotationTableAppendRowRequestDto

table_key

string · enum · required

Enum values:

line_items

tax_detail

Example: line_items

PostAnnotationTableDuplicateRequestDto

table_key

string · enum · required

Enum values:

line_items

tax_detail

Example: line_items

index

number · min: 0 · required

Annotation table row index (0-based) to be duplicated

PostAnnotationTableRemoveAllRequestDto

table_key

string · enum · required

Enum values:

line_items

tax_detail

Example: line_items

PostAnnotationTableRemoveRowRequestDto

table_key

string · enum · required

Enum values:

line_items

tax_detail

Example: line_items

index

number · min: 0 · required

Annotation table row index (0-based) to be removed

PostAnnotationTableRemoveRowsRequestDto

table_key

string · enum · required

Enum values:

line_items

tax_detail

Example: line_items

indexes

number[] · required

PostApprovalAutomationDto

name

string | null · required

action

string · enum · required

Enum values:

assign_approval_route

assign_approvers

move_to_next_stage

required

AutomationConditionsRawDto · required

PostApprovalRouteDto

name

string · required

order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

users

array | null · minItems: 1

delegation

string · enum

Enum values:

enabled

disabled

array · minItems: 1

object

PostApprovalRouteGroupDto

approval_group_id

string · uuid · required

approval_group_policy

string · enum · required

Enum values:

ALL_MEMBERS_MUST_APPROVE

ANY_MEMBER_CAN_APPROVE

MAJORITY_MUST_APPROVE

PostApprovalRouteUserDto

user_id

string · uuid · required

PostBankTransferSubscriptionDto

StripeLineItem[] · required

contract_period

string · enum · required

Enum values:

monthly

yearly

biyearly

is_individual_tier

boolean | null

PostBulkMoveDocumentsResponseDto

MoveDocumentsResponseDto · required

PostBulkPartialPaymentItem

document_id

string · uuid · required

mode

string · enum · required

Enum values:

add

set

amount

number · min: 1 · required

PostBulkPartialPaymentRequest

PostBulkPartialPaymentItem[] · required

PostBulkPaymentRequest

object · required

payment_status

string · enum · required

Document payment status

Enum values:

paid

paid_partially

unpaid

to_pay

payment_order

past_due

search

string | null

PostBulkShareLinksDto

document_ids

string[] · required

action

string · enum · required

Enum values:

publish

unpublish

expires_at

string | null · date-time

PostConnectLinkedAccountResponseDto

LinkedAccountDto · required

PostCreditsSessionCheckoutDto

StripeLineItem · required

success_url

string | null

cancel_url

string | null

PostDocumentForgetBodyDto

field_key

string · required

index

number

PostDocumentLearnBodyDto

object · required

An object of annotations

Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}],"due_date":[{"value":"01.01.2021","iso_date_value":"2021-01-01"}],"bank_account":[{"value":"123"},{"value":"456"}],"line_items":[{"activity":[{"value":"item1"}],"total_incl_tax":[{"value":"123","numeric_value":123}]},{"activity":[{"value":"item2"}],"total_incl_tax":[{"value":"456","numeric_value":456}]}]}

line_items_visibility

string · enum

Enum values:

visible

hidden

tax_detail_visibility

string · enum

Enum values:

visible

hidden

PostDocumentWithNextDocumentDto

lock_next_document

boolean · required

PatchNextDocumentDto · required

stage

string · enum · required

Document stage

Enum values:

to-validation

to-approve

later

sent

deleted

rejected

spam

none

rejection_reason

string | null

PostDocumentsStageDto

object · required

queue_id

string · uuid · required

stage

string · enum · required

Document stage

Enum values:

to-validation

to-approve

later

sent

deleted

rejected

spam

none

rejection_reason

string | null

search

string | null

PostInviteUsers

EmailWithRolesInWorkspaceQueuesDto[] · required

PostInviteUsersResponseDto

data

string[] · required

successfully_invited_user_emails

string[] · required

unsuccessfully_invited_user_emails

string[] · required

PostInviteUsersToOrganizationBodyDto

PostInviteUsersToOrganizationUserDto[] · required

PostInviteUsersToOrganizationMembershipDto

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

customer

email

entity_id

string · required

role

string · enum · required

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

include_actions

array | null

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

PostInviteUsersToOrganizationResponseDataDto

RoleManageAffectedUserDto[] · required

PostInviteUsersToOrganizationResponseErroredDto[] · required

PostInviteUsersToOrganizationResponseDto

PostInviteUsersToOrganizationResponseDataDto · required

PostInviteUsersToOrganizationResponseErroredDto

email

string · email · required

reason

string · required

PostInviteUsersToOrganizationUserDto

email

string · email · required

PostInviteUsersToOrganizationMembershipDto[] · required

PostLineItemsTemplateInput

name

string · maxLength: 100 · required

document_id

string · uuid · required

PostMailDocumentSharingLinkRequestDto

email

string · email · required

Email on which the share link will be sent

subject

string | null

message

string | null

PostQueueSetSchemaVisibilityInputDto

SetSchemaFieldVisibilityDto[] · required

PostRelearnBodyDto

name

string | null · required

register_id

string | null · required

tax_id

string | null · required

value

string | null · required

field_key

string · required

PostSessionCheckoutDto

StripeLineItem[] · required

contract_period

string · enum · required

Enum values:

monthly

yearly

biyearly

success_url

string | null

cancel_url

string | null

is_individual_tier

boolean | null

discount_code

string | null

PostSocialLoginRequestDto

email

string · email · required

id_token

string · required

PostStorageNodeToQueueDto

queue_id

string · uuid · required

PreviewInvoiceDto

CustomStripeLineItem · required

CustomStripeLineItem[] · required

Price

id

string · required

currency

string · required

active

boolean · required

type

string · required

unit_amount

number | null · required

TierPrice[]

object

PriceMetadata

tooltip

string | null

Prices

object

PromoCodeDto

duration

string · required

percent_off

number

amount_off

number

currency

string | null

duration_in_months

number

name

string | null

PromoCodeResponseDto

PromoCodeDto · required

ProrationPreviewDataDto

prorated_amount

number · required

upcoming_invoice_amount

number · required

upcoming_invoice_date

number · required

ProrationPreviewDto

workspaces

number · required

approvers

number · required

ProrationPreviewResponseDto

ProrationPreviewDataDto · required

PushTokenStatus

string · enum

Enum values:

enabled

paused

expired

PutApplyLineItemsTemplateInputDto

template_id

string · uuid · required

PutApprovalRouteDto

order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

users

array | null · minItems: 1

delegation

string · enum

Enum values:

enabled

disabled

array · minItems: 1

object

name

string | null

PutDocumentApprovalRouteDto

order

string · enum · required

Document approval order

Enum values:

ORDERED

DISORDERED

SINGLE_APPROVAL_AVAILABLE

delegation

string · enum

Enum values:

enabled

disabled

object

users

string[]

array

PutStorageAnnotationSchemaDto

node_id

string | null · uuid · required

StorageFolderAnnotationSchemaFieldDto[] · required

PutStorageNodeQueueSyncItemDto

queue_id

string · uuid · required

enabled

boolean · required

PutStorageNodeQueueSyncsDto

PutStorageNodeQueueSyncItemDto[] · required

QueueApiResponse

QueueWithAnnotationSchemaDto · required

QueueCreationOptionsDto

type

string · enum · required

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

purchase-order

other

name

string | null · minLength: 1 · required

A name of a queue

locale

string · enum · required

Enum values:

cs

sk

en

currency

string · minLength: 1 · required

Currency assigned to the queue (ISO code)

approval

boolean | null

Whether to use approval flow

Default: false

extraction

boolean | null

Whether to allow extraction of documents

Default: true

QueueDocumentsCountResponseDto

DocumentsAggregatedCounts · required

QueueExcludeFields

string · enum

Enum values:

annotation-schema

QueueFeatureRequest

enabled

boolean · required

QueueFeatureResponse

enabled

boolean · required

QueueFeatureStatusEnum

string · enum

Enum values:

enabled

disabled

QueueFeaturesDto

extraction

string · enum · required

Enum values:

enabled

disabled

approval

string · enum · required

Enum values:

enabled

disabled

relearning

string · enum · required

Enum values:

enabled

disabled

isdoc_extraction

string · enum · required

Enum values:

enabled

disabled

invalid_invoice_detection

string · enum · required

Enum values:

enabled

disabled

bounce_email

string · enum · required

Enum values:

enabled

disabled

ai_template_matching

string · enum · required

Enum values:

enabled

disabled

ai_line_items_template_matching

string · enum · required

Enum values:

enabled

disabled

ai_automated_accounting

string · enum · required

Enum values:

enabled

disabled

advanced_approval

string · enum · required

Enum values:

enabled

disabled

advanced_approval_auto_export

string · enum · required

Enum values:

enabled

disabled

audit_log

string · enum · required

Enum values:

enabled

disabled

split_document_by_qr_code

string · enum · required

Enum values:

enabled

disabled

llm_accuracy_extraction

string · enum · required

Enum values:

enabled

disabled

registers_frequent_items

string · enum · required

Enum values:

enabled

disabled

show_to_validation

string · enum · required

Enum values:

enabled

disabled

disable_approval_reject

string · enum · required

Enum values:

enabled

disabled

approval_with_note

string · enum · required

Enum values:

enabled

disabled

annotation_amounts_suggestions

string · enum · required

Enum values:

enabled

disabled

context_template_matching

string · enum · required

Enum values:

enabled

disabled

context_template_matching_line_items

string · enum · required

Enum values:

enabled

disabled

delegate_approval

string · enum · required

Enum values:

enabled

disabled

approve_assign_approval

string · enum · required

Enum values:

enabled

disabled

skip_edi_description_ai_acc

string · enum · required

Enum values:

enabled

disabled

ai_period_increment

string · enum · required

Enum values:

enabled

disabled

auto_attach_email_attachments

string · enum · required

Enum values:

enabled

disabled

QueueIncludeFields

string · enum

Enum values:

access-actions

documents-to-process-count

settings

documents-count

features

workspace-metadata

extraction-evaluation

inbox

QueueResponseDto

QueueWithAnnotationSchemaDto · required

QueueSchemaContext

string · enum

Enum values:

user

queue

QueueSettingsDto

AnnotationSchemaColumnsDto[] · required

QueueSettingsResponseDto

QueueSettingsDto · required

QueueTypeEnum

string · enum

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

purchase-order

other

QueueUserDto

id

string · uuid · required

name

string | null · required

email

string · required

status

string · enum · required

Enum values:

initial

enabled

disabled

profile_avatar_url

string | null · required

QueueUserReplacementDto

replacement_user_id

string · uuid · required

User who will take over the approval steps

queue_ids

string[] · required

Queues where this replacement applies

QueueUserWithDelegatesDto

id

string · uuid · required

name

string | null · required

email

string · required

status

string · enum · required

Enum values:

initial

enabled

disabled

profile_avatar_url

string | null · required

EnhancedDelegateDto[] · required

QueueUsersResponseDto

QueueUserDto[] · required

QueueUsersWithDelegatesResponseDto

QueueUserWithDelegatesDto[] · required

QueueWithAnnotationSchemaDto

id

string · uuid · required

humanized_id

number · required

created_at

string · date-time · required

A datetime in ISO8601 with time zone

type

string · enum · required

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

purchase-order

other

currency

string · required

workspace_id

string · uuid · required

organization_id

string · uuid · required

inbox_hash

string · required

inbox_hash_prefix

string · required

inbox

string · required

extraction_evaluation

string · enum · required

Enum values:

enabled

disabled

automation_rules

string · enum · required

Enum values:

enabled

disabled

accounting_automation_rules

string · enum · required

Enum values:

enabled

disabled

extracted_pages_limit

number · required

name

string | null

AnnotationSchemaDto[]

An annotation schema

access_actions

MembershipAccessActions[]

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

documents_to_process_count

number

object

Queue settings

object

Workspace metadata

object

array | null

validations_settings

object

QueuesApiResponse

QueueWithAnnotationSchemaDto[] · required

A list of queues

PaginationDto · required

QueuesResponseDto

QueueWithAnnotationSchemaDto[] · required

QuoteProductDto

id

string · required

name

string · required

order

number · required

price

number · required

recurring

string · required

quantity

number

key

string | null

RangeFilterApiResponse

RangeFilterField · required

RangeFilterField

min

number | null · required

max

number | null · required

RawAnnotationValueDto

index

number · required

RegionDto · required

raw_value

string

ReExtractionEnum

string · enum

Enum values:

enabled

disabled

RefreshTokenRequestDto

refresh_token

string · required

RegionDto

left

number · required

top

number · required

width

number · required

height

number · required

page

number · min: 1 · required

RegisterChangeDto

type

string · required

RegisterDto

id

string · uuid · required

type

string · required

RegisterInternalDto

id

string · uuid · required

type

string · required

internal

boolean

hide_register_value

boolean

RegisterItemDto

value

string | null · required

label

string · required

shown_label

string · required

RegisterOptionDto

label

string · required

A label that will be shown in an UI

value

string · required

A value that will be set when a user chooses this option

alias

string | null

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

RegisterUploadMethod

string · enum

Enum values:

replace

append

upsert

RegistersApiResponse

RegisterItemDto[] · required

PaginationDto · required

RegistersInternalResponseDto

RegisterInternalDto[] · required

RemoveApprovalImpactParamsDto

action

string · enum · required

Must be "remove"

Enum values:

remove

target_user_id

string · uuid · required

User being replaced or removed

skip_reason

string · enum · required

Reason why the user is being removed or replaced

Enum values:

DEACTIVATED

NO_APPROVER_RIGHTS

queue_ids

string[] · required

Queues from which the user is removed

RemoveBasicAnnotationInputDto

field

string · required

Annotation field to be updated

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

RemoveNodeAnnotationDto

field

string · required

Annotation field to be updated

action

string · enum · required

Enum values:

remove

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

ReplaceApprovalImpactParamsDto

action

string · enum · required

Must be "replace"

Enum values:

replace

target_user_id

string · uuid · required

User being replaced or removed

skip_reason

string · enum · required

Reason why the user is being removed or replaced

Enum values:

DEACTIVATED

NO_APPROVER_RIGHTS

QueueUserReplacementDto[] · required

Replacement users per set of queues

ReportDateAggInterval

string · enum

Enum values:

day

week

month

year

ReportTimeSpentFiltersDto

annotations_source

string · enum

Document source

Enum values:

ai

edi

none

RequestAdditionalApproversBodyDto

additional_approvers

number · required

Number of additional approvers to purchase

RequestRegionPointDto

left

number · required

top

number · required

page

number · min: 1 · required

ResendInvitationDto

user_id

string · uuid · required

ResetPasswordRequestDto

email

string · email · required

RoleManageAffectedUserDto

user_id

string · uuid · required

RowValidationMessageDto

table_key

string · required

row_index

number · required

object · required

ScheduledTaskDto

affected

number · required

not_affected

number · required

id

string · uuid · required

status

string · enum · required

Enum values:

pending

running

completed

failed

failed_to_clean

ScheduledTaskResponseDto

ScheduledTaskDto · 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

name

string · required

registration_number

string | null · required

tax_number

string | null · required

vat_number

string | null · required

SearchType

string · enum

Enum values:

name

registration_number

vat_number

SectionVisibilityEnum

string · enum

Enum values:

visible

hidden

SepaPaymentDialogAlphanumericDataType

value

string | null · required

errors

SepaPaymentItemError[] · 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

var_sym_too_long

ValidationResultDto[] · required

SepaPaymentDialogNumericDataType

value

string | null · required

numeric_value

number | null · required

errors

SepaPaymentItemError[] · 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

var_sym_too_long

ValidationResultDto[] · required

SepaPaymentItemData

SepaPaymentDialogAlphanumericDataType · required

SepaPaymentDialogNumericDataType · 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

var_sym_too_long

ServiceAccountTokenDto

access_token

string · required

ServiceAccountTokenResponseDto

ServiceAccountTokenDto · required

SetOrderAutomationRulesBodyDto

ids

string[] · required

SetSchemaFieldVisibilityDto

field_key

string · required

hidden

boolean · required

SetSchemaVisibilityResponseDto

AnnotationSchemaDto[] · required

An annotation schema

ShareLinkAction

string · enum

Enum values:

publish

unpublish

ShareLinkPermission

string · enum

Enum values:

viewer

editor

SortDirection

string · enum

Enum values:

asc

desc

SortQuery

field

string · 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, last_updated_by_customer_name, last_updated_by_customer_date, workspace_name, queue_name)

direction

string · enum · required

Enum values:

asc

desc

SseDocumentExportProgressDataDto

id

string · uuid · required

progress

number · required

SseDocumentExtractedPayloadDto

document_id

string · uuid · required

StageAggregationData

stage

string · enum · required

Enum values:

to-validation

to-approve

later

duration

number · required

StatusChangeCountsAggregatedDto

date

string · date-time · required

date_label

string · required

count

number · required

UserStatusChangeDto[] · required

StatusHistoryCountsPerQueueDto

queue_id

string · uuid · required

queue_name

string · required

queue_humanized_id

number · required

unresolved

number · required

sent

number · required

skipped

number · required

deleted

number · required

UserStatusHistoryDto[] · required

StatusHistoryTimeBucketDto[]

StatusHistoryCountsPerWorkspaceDto

workspace_id

string · required

workspace_name

string · required

workspace_humanized_id

number · required

unresolved

number · required

sent

number · required

skipped

number · required

deleted

number · required

StatusHistoryCountsPerQueueDto[] · required

StatusHistoryTimeBucketDto[]

StatusHistoryTimeBucketDto

unresolved

number · required

sent

number · required

skipped

number · required

deleted

number · required

date

string · required

date_label

string · required

StorageAnnotationSchemaResponseDto

StorageFolderAnnotationSchemaFieldResponseDto[] · required

StorageBreadcrumbDto

id

string · uuid · required

name

string · required

StorageCommentDto

id

string · uuid · required

object · required

DeltaOpDto[] · required

created_at

string · date-time · required

updated_at

string · date-time · required

deleted_at

string | null · required

created_by_id

string | null · uuid · required

share_link_id

string | null · uuid · required

share_link_access_label

string | null · required

deletion_allowed

boolean · required

parent_id

string | null · uuid · required

StorageCommentResponseDto

StorageCommentDto · required

StorageCommentThreadDto

id

string · uuid · required

object · required

DeltaOpDto[] · required

created_at

string · date-time · required

updated_at

string · date-time · required

deleted_at

string | null · required

created_by_id

string | null · uuid · required

share_link_id

string | null · uuid · required

share_link_access_label

string | null · required

deletion_allowed

boolean · required

StorageCommentThreadDto[] · required

StorageCommentThreadsResponseDto

StorageCommentThreadDto[] · required

StorageFilterableValuesResponseDto

ValueFilterField[] · required

StorageFolderAnnotationSchemaFieldDto

key

string · required

datatype

string · enum · required

Entity datatype. Mandatory only for field type item.

Enum values:

numeric

date

alphanumeric

register

message

string | null

message_key

string | null

multiline

boolean | null

hidden

boolean | null

StorageFolderAnnotationSchemaFieldOptionDto[]

StorageFolderAnnotationSchemaFieldOptionDto

value

string | null · required

message_key

string | null

label

string | null

StorageFolderAnnotationSchemaFieldOptionResponseDto

value

string | null · required

label

string · required

message_key

string | null

StorageFolderAnnotationSchemaFieldResponseDto

key

string · required

datatype

string · enum · required

Entity datatype. Mandatory only for field type item.

Enum values:

numeric

date

alphanumeric

register

message

string · required

custom

boolean · required

message_key

string | null

multiline

boolean | null

hidden

boolean | null

StorageFolderAnnotationSchemaFieldOptionResponseDto[]

StorageFolderIconColor

string · enum

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

StorageNodeAuditLogHumanizedItemDto

date

string · date-time · required

operation

string · enum · required

Enum values:

add

update

delete

text

string · required

user_id

string | null · uuid

share_link_id

string | null · uuid

StorageNodeAuditLogHumanizedOperation

string · enum

Enum values:

add

update

delete

StorageNodeAuditLogHumanizedResponseDto

StorageNodeAuditLogHumanizedItemDto[] · required

array of response data

object · required

pagination

StorageNodeDto

id

string · uuid · required

type

string · enum · required

Enum values:

folder

file

name

string · required

path

string · required

depth

number · required

parent_id

string | null · uuid · required

owner_id

string · uuid · required

size_bytes

number | null · required

storage_key

string | null · required

mime_type

string | null · required

icon_color

string · enum · required

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

inbox_hash_prefix

string | null · required

inbox

string | null · required

object | null · 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}]}]}

permission

string · enum · required

Enum values:

viewer

editor

owner

created_by_id

string | null · uuid · required

last_updated_by_customer_id

string | null · uuid · required

last_updated_by_share_link_id

string | null · uuid · required

received_from_email

string | null · required

created_at

string · date-time · required

updated_at

string · date-time · required

array | null

last_updated_by_customer_at

string | null · date-time

object

StorageNodeEnhancedDto

id

string · uuid · required

type

string · enum · required

Enum values:

folder

file

name

string · required

path

string · required

depth

number · required

parent_id

string | null · uuid · required

owner_id

string · uuid · required

size_bytes

number | null · required

storage_key

string | null · required

mime_type

string | null · required

icon_color

string · enum · required

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

inbox_hash_prefix

string | null · required

inbox

string | null · required

object | null · 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}]}]}

permission

string · enum · required

Enum values:

viewer

editor

owner

created_by_id

string | null · uuid · required

last_updated_by_customer_id

string | null · uuid · required

last_updated_by_share_link_id

string | null · uuid · required

received_from_email

string | null · required

created_at

string · date-time · required

updated_at

string · date-time · required

owner_name

string | null · required

owner_email

string · required

StorageNodeQueueDto[] · required

array | null

last_updated_by_customer_at

string | null · date-time

object

StorageNodeFiltersQuery

owner_ids

array | null

updated_at_gte

string | null · date-time

updated_at_lte

string | null · date-time

created_at_gte

string | null · date-time

created_at_lte

string | null · date-time

types

string[]

StorageNodeNavigationDto

prev_node_id

string | null · uuid · required

next_node_id

string | null · uuid · required

StorageNodePermission

string · enum

Enum values:

viewer

editor

owner

StorageNodePermissionItemResponseDto

email

string · email · required

permission

string · enum · required

Enum values:

viewer

editor

owner

StorageNodePermissionResponseDto

StorageNodePermissionItemResponseDto[] · required

StorageNodeQueueDto

id

string · uuid · required

humanized_queue_id

number · required

queue_type

string · enum · required

Enum values:

issued-invoice

received-invoice

receipt

contract-order

inbox

purchase-order

other

document_id

string · uuid · required

name

string · required

workspace_name

string · required

StorageNodeQueueSyncDto

id

string · uuid · required

queue_id

string · uuid · required

enabled

boolean · required

StorageNodeQueueSyncsResponseDto

StorageNodeQueueSyncDto[] · required

StorageNodeResponseDto

StorageNodeDto · required

StorageNodeSortField

string · enum

Enum values:

name

updated_at

created_at

owner

StorageNodeSortQuery

field

string · enum · required

Enum values:

name

updated_at

created_at

owner

direction

string · enum · required

Enum values:

asc

desc

StorageNodeType

string · enum

Enum values:

folder

file

StorageNodesEnhancedItemDto

StorageNodeEnhancedDto[] · required

StorageBreadcrumbDto[] · required

object · required

StorageNodesEnhancedResponseDto

StorageNodesEnhancedItemDto · required

StorageNodesResponseDto

StorageNodeDto[] · required

StorageShareLinkAccessMode

string · enum

Enum values:

anyone

organization

specific_users

StorageShareLinkAnyoneDto

permission

string · enum · required

Enum values:

viewer

editor

type

string · enum · required

Enum values:

anyone

StorageShareLinkDataDto

share_link

string | null · required

organization_name

string | null

StorageShareLinkOrganizationDto

permission

string · enum · required

Enum values:

viewer

editor

type

string · enum · required

Enum values:

organization

StorageShareLinkResolveDataDto

StorageNodeDto · required

permission

string · enum · required

Enum values:

viewer

editor

owner

access_mode

string · enum · required

Enum values:

anyone

organization

specific_users

StorageShareLinkResolveResponseDto

StorageShareLinkResolveDataDto · required

StorageShareLinkResponseDto

StorageShareLinkDataDto · required

StorageShareLinkSpecificUsersDto

permission

string · enum · required

Enum values:

viewer

editor

users_emails

string[] · required

type

string · enum · required

Enum values:

specific_users

StringBoolean

string · enum

Enum values:

true

false

StripeLineItem

price

string · required

quantity

number

StripeRangeParamsDto

gt

number

gte

number

lt

number

lte

number

StripeTiersDto

TierDto[] · required

BillingFeatureDto[] · required

BillingIntegrationDto[] · required

BillingUser[] · required

BillingWorkspace[] · required

BillingCredit[] · required

SubscriptionBillingCredit[] · required

StripeTiersResponseDto

StripeTiersDto · required

SubjectSearchResultResponse

SearchSubjectDto[] · required

SubscriptionBillingCredit

id

string · required

credits

number · required

Prices · required

SubscriptionPaymentMethod

string · enum

Enum values:

card

bank_transfer

SubscriptionProductsDto

products

string[] · required

SubscriptionProductsResponseDto

SubscriptionProductsDto · required

TableAnnotationChangeDto

table_key

string · required

field

string · required

row_index

number · required

index

number · required

required

List of changed annotations

TagDto

id

string · uuid · required

name

string · required

color

string · enum · required

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

TagResponseDto

TagDto · required

TagUpdateDto

name

string | null

color

string · enum

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

TagsResponseDto

TagDto[] · required

TaxDetailDataResponse

AnnotationTableRowDto[] · required

TaxDetailResponseDto

TaxDetailDataResponse · required

PaginationDto · required

ThirdPartyValidationSettingsDto

key

string · enum · required

Enum values:

accounting_confidence_check

adis_bank_check

adis_reliable_payer

vies

ares

status

string · enum · required

Enum values:

enabled

disabled

AccountingConfidenceValidationParamsDto

Tier

string · enum

Enum values:

trial

tier_1

tier_2

tier_3

individual

temp_individual

TierDto

id

string · required

name

string · required

internal_id

string · required

order

number · required

included_users

number · required

included_approvers

number · required

included_workspaces

number · required

included_documents

number · required

Prices · required

TierIncludedFeature[] · required

TierIncludedFeature

key

string · required

status

string · enum · required

Enum values:

enabled

disabled

has_tooltip

boolean | null

TierPrice

up_to

number | null · required

unit_amount

number | null · required

TimeSpentPerDocumentAggregationDto

queue_id

string · uuid · required

queue_name

string · required

queue_humanized_id

number · required

workspace_id

string · required

workspace_name

string · required

workspace_humanized_id

number · required

document_id

string · uuid · required

document_page_count

number · required

duration

number · required

TimeSpentPerQueueAggregationDto

queue_id

string · uuid · required

queue_name

string · required

queue_humanized_id

number · required

duration

number · required

TimeSpentTimeBucketDto[]

TimeSpentPerSessionAggregationDto

queue_id

string · uuid · required

queue_name

string · required

queue_humanized_id

number · required

workspace_id

string · required

workspace_name

string · required

workspace_humanized_id

number · required

user_id

string · uuid · required

user_name

string | null · required

user_email

string · required

document_id

string · uuid · required

document_page_count

number · required

start

string · date-time · required

end

string · date-time · required

stage

string · enum · required

Enum values:

to-validation

to-approve

later

duration

number · required

TimeSpentPerUserAggregationDto

user_id

string · uuid · required

user_name

string | null · required

user_email

string · required

duration

number · required

TimeSpentTimeBucketDto[]

TimeSpentPerWorkspaceAggregationDto

workspace_id

string · required

workspace_name

string · required

workspace_humanized_id

number · required

duration

number · required

TimeSpentPerQueueAggregationDto[] · required

TimeSpentTimeBucketDto[]

TimeSpentTimeBucketDto

date

string · required

date_label

string · required

duration

number · required

TokenResponseDto

access_token

string · required

JWT access token

refresh_token

string · required

JWT refresh token

expires_at

string · date-time · required

refresh_token_expires_at

string · date-time · required

UILocale

string · enum

Enum values:

cs_CZ

en_GB

cs

en

UpdateAnnotationAuxDto

object | null · required

An object of annotations changes

Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}]}

RegisterChangeDto[] · required

object · required

Annotations global status

UpdateAnnotationGlobalStatusDto

AnnotationsGlobalStatusDto · required

UpdateAnnotationGlobalStatusResponseDto

UpdateAnnotationGlobalStatusDto · required

UpdateAnnotationResponseDto

UpdateAnnotationAuxDto · required

UpdateAnnotationSchemaDto

AnnotationSchemaDto[] · minItems: 1 · required

UpdateBasicAnnotationInputDto

field

string · required

Annotation field to be updated

object · required

Annotation value object to be set

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

UpdateEdiWorkspaceInvitationDto

peer_workspace_id

string · uuid · required

update_status

string · enum · required

Enum values:

accept

reject

UpdateEdiWorkspaceInvitationEnum

string · enum

Enum values:

accept

reject

UpdateExternalValidationLinkDto

type

string · enum · required

Enum values:

initial_document_validation

document_validation

url

string · url · required

URL must be a valid HTTP URL

signature_verification

string · enum

Enum values:

enabled

disabled

UpdateNodeAnnotationDto

field

string · required

Annotation field to be updated

AnnotationValueInput · required

action

string · enum · required

Enum values:

update

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

UpdateSubscriptionDto

CustomStripeLineItem · required

CustomStripeLineItem[] · required

payment_method

string · enum

Enum values:

card

bank_transfer

UpdateTableAnnotationAuxDto

TableAnnotationChangeDto[] · required

RegisterChangeDto[] · required

object · required

Annotations global status

AnnotationTableValueTotalDto[] · required

array | null

UpdateTableAnnotationInputDto

field

string · required

Annotation field to be updated

table_key

string · enum · required

Annotation table to be updated

Enum values:

line_items

tax_detail

row_index

number · min: 0 · required

Annotation table row index (0-based) to be updated

object · required

Annotation value object to be set

index

number · min: 0

Zero based index of the annotation value of a field. Mostly used for multivalue fields.

UpdateTableAnnotationResponseDto

UpdateTableAnnotationAuxDto · required

UpdateWebhookDto

url

string · url · required

URL must be a valid HTTP URL

signature_verification

string · enum

Enum values:

enabled

disabled

destination_id

string | null · uuid

UpdateWorkspacesApproversDataDto

status

string · enum · required

Enum values:

paid

requires_action

requires_payment_method

processing

scheduled

invoice_issued

client_secret

string | null

hosted_invoice_url

string | null

schedule_id

string | null

invoice_number

string | null

due_date

string | null

UpdateWorkspacesApproversDto

workspaces

number · required

approvers

number · required

payment_method_id

string | null

payment_method

string · enum

Enum values:

card

bank_transfer

UpdateWorkspacesApproversResponseDto

UpdateWorkspacesApproversDataDto · required

UpdatedSubscriptionDto

status

string · enum · required

Enum values:

paid

requires_action

requires_payment_method

processing

invoice_issued

client_secret

string | null

hosted_invoice_url

string | null

invoice_number

string | null

due_date

string | null

UpdatedSubscriptionResponseDto

UpdatedSubscriptionDto · required

UpgradeRequestDto

user_id

string · uuid · required

user_name

string | null · required

user_email

string · required

additional_approvers

number · required

requested_at

string | null · required

UpgradeStatus

string · enum

Enum values:

paid

requires_action

requires_payment_method

processing

invoice_issued

UploadDocumentAnnotationCommentsDataDto

DeltaOpDto[] · minItems: 1 · required

object

UploadDocumentEmailDataDto

subject

string · required

body-html

string · required

sender

string · required

body-plain

string | null

UploadEdiWorkspaceCompaniesDto

workspace_id

string · uuid · required

EdiCompanyDto[] · required

edi_workspace_companies_upload_method

string | null · enum

Enum values:

replace

append

Default: replace

UploadFilesDto

parent_id

string | null · uuid

relative_paths

array | null

UploadQueueRegistersDto

UploadRegisterRequest[] · minItems: 1 · required

method

string · enum · required

Enum values:

replace

append

upsert

queue_id

string · uuid · required

UploadRegisterRequest

type

string · required

RegisterOptionDto[] · required

UploadedFilesResponse

document_ids

string[] · required

UpsertUserReportSettingsBodyDto

data

object · required

UserAggregationDataDto

user_id

string · uuid · required

user_name

string | null · required

user_email

string · required

duration

number · required

DocumentAggregationDataDto[] · required

UserApprovalStatus

string · enum

Enum values:

enabled

disabled

UserApprovalStatusDto

status

string · enum · required

Enum values:

enabled

disabled

UserApprovalStatusResponseDto

UserApprovalStatusDto · required

UserCommentsStatus

string · enum

Enum values:

enabled

disabled

UserDto

id

string · uuid · required

ui_locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

name

string | null · required

email

string · email · required

status

string · enum · required

Enum values:

initial

enabled

disabled

otp_status

string · enum · required

Enum values:

disabled

unverified

enabled

object · required

created_at

string · date-time · required

profile_avatar_url

string | null · required

UserMembershipDto

EnhancedUserDto · required

is_manageable

boolean · required

highest_role_in_organization

string · enum · required

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

MembershipDto[] · required

invitation_status

string · enum · required

Enum values:

expired

active

is_out_of_office

boolean · required

UserNotificationsResponseDto

LocalizedUserNotificationDto[] · required

array of response data

object · required

pagination

UserOnboardingMetadataDto

phone

string | null · required

email

string · email · required

company

string | null

register_id

string | null

vat_id

string | null

erp

string | null

invoice_count

number

UserOrganizationBillableFeaturesStatusDto

comments

string · enum · required

Enum values:

enabled

disabled

approval

string · enum · required

Enum values:

enabled

disabled

two_factor_authentication

string · enum · required

Enum values:

enabled

disabled

UserOrganizationBillableFeaturesStatusResponseDto

UserOrganizationBillableFeaturesStatusDto · required

UserOtpResponseDto

UserOtpSettingsDto · required

UserOtpSettingsDto

otp_secret

string | null · required

otp_uri

string | null · required

otp_status

string · enum · required

Enum values:

disabled

unverified

enabled

otp_last_verification_date

string | null · required

UserReportSettingsDto

user_id

string · uuid · required

organization_id

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

data

object · required

UserReportSettingsResponseDto

object · required

UserResponseDto

UserDto · required

UserRoleManageDataDto

user_id

string · uuid · required

array · required

UserRoleManageDeleteDataDto

action

string · required

membership_id

string · uuid · required

UserRoleManageInsertDataDto

action

string · required

role

string · enum · required

Enum values:

owner

admin

supervisor

editor

restricted-editor

uploader

viewer

entity_id

string · uuid · required

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

customer

email

include_actions

MembershipAccessActions[]

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

UserRoleManageNotAffectedDto

user_id

string · uuid · required

error

string · required

UserRoleManageResponseDto

UsersRoleManageResponseDataDto · required

UserRolesInWorkspaceQueues

workspace_id

string | null · uuid · required

AddUserRoleInQueueDto[] · required

UserStatus

string · enum

Enum values:

initial

enabled

disabled

UserStatusChangeBreakdownDto

status

string · enum · required

Enum values:

received

enqueued-for-extraction

extraction-errored

extraction-rejected

waiting-for-human-validation

waiting-for-human-approval

deleted

postponed

count

number · required

UserStatusChangeDto

user_id

string · uuid · required

user_name

string | null · required

user_email

string · required

count

number · required

UserStatusChangeBreakdownDto[] · required

UserStatusHistoryDto

user_id

string · uuid · required

user_name

string | null · required

user_email

string · required

unresolved

number · required

sent

number · required

skipped

number · required

deleted

number · required

StatusHistoryTimeBucketDto[]

UserTypeEnum

string · enum

Enum values:

customer

service_account

UserWithDefaultOrganization

id

string · uuid · required

ui_locale

string · enum · required

Enum values:

cs_CZ

en_GB

cs

en

name

string | null · required

email

string · email · required

status

string · enum · required

Enum values:

initial

enabled

disabled

otp_status

string · enum · required

Enum values:

disabled

unverified

enabled

object · required

created_at

string · date-time · required

profile_avatar_url

string | null · required

organization_id

string | null · uuid · required

workspace_id

string | null · uuid · required

queue_id

string | null · uuid · required

organization_humanized_id

number | null · required

workspace_humanized_id

number | null · required

queue_humanized_id

number | null · required

HighestUserRoleInOrganizationDto[] · required

NotificationSettingsDto · required

FeatureFlagsDto · required

internal_tester

boolean · required

UserWithDefaultOrganizationResponseDto

UserWithDefaultOrganization · required

UsersRoleManageBodyDto

UserRoleManageDataDto[] · required

UsersRoleManageResponseDataDto

RoleManageAffectedUserDto[] · required

UserRoleManageNotAffectedDto[] · required

ValidatedAnnotationsDto

object · required

An object of annotations

Example: {"invoice_id":[{"value":"123"}],"total_due":[{"value":"123","numeric_value":123}],"due_date":[{"value":"01.01.2021","iso_date_value":"2021-01-01"}],"bank_account":[{"value":"123"},{"value":"456"}],"line_items":[{"activity":[{"value":"item1"}],"total_incl_tax":[{"value":"123","numeric_value":123}]},{"activity":[{"value":"item2"}],"total_incl_tax":[{"value":"456","numeric_value":456}]}]}

object · required

Annotations global status

ValidatedAnnotationsResponseDto

ValidatedAnnotationsDto · required

ValidationKey

string · enum

Enum values:

apply_accounting_automation

accounting_confidence_check

llm_extraction_post_processor

annotations_duplicates_remover

remove_entity_filterer

apply_approval_route

apply_document_template

apply_registers_preset

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

message

string | null · required

message_key

string · enum · required

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

severity

string · enum · required

Enum values:

seenByHuman

info

warning

error

autofilled_from

string

validation_key

string · enum

Enum values:

apply_accounting_automation

accounting_confidence_check

llm_extraction_post_processor

annotations_duplicates_remover

remove_entity_filterer

apply_approval_route

apply_document_template

apply_registers_preset

validation_timestamp

number | null

ValidationSettingStatus

string · enum

Enum values:

enabled

disabled

ValueFieldFieldTagMetadata

color

string · enum · required

Enum values:

#3F90FF

#9555FF

#F490CC

#FF4A4A

#FF7226

#FFA030

#70BB25

#1AA98F

ValueFilterApiResponse

ValueFilterField[] · required

ValueFilterField

key

string · required

label

string | null

object

hide_value

boolean | null

VerifyOtpDto

otp

string · required

WebhookApiResponseDto

WebhookResponseDto · required

WebhookEntityTypeEnum

string · enum

Enum values:

organization

workspace

queue

document

WebhookResponseDto

id

string · uuid · required

entity_id

string · uuid · required

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

url

string · url · required

URL must be a valid HTTP URL

signature_verification

string · enum · required

Enum values:

enabled

disabled

type

string · enum · required

Enum values:

document_status_changed

queue_created

initial_document_validation

document_validation

WebhookSignatureVerification

string · enum

Enum values:

enabled

disabled

WebhookSigningKeyDto

webhook_signing_key

string · required

WebhookSigningKeyResponseDto

WebhookSigningKeyDto · required

WebhookType

string · enum

Enum values:

document_status_changed

queue_created

initial_document_validation

document_validation

WebhooksApiResponseDto

WebhookResponseDto[] · required

WorkspaceDto

id

string · uuid · required

humanized_id

number · required

name

string · required

region

string · enum · required

Enum values:

cs

sk

uk

none

register_id

string | null · required

tax_id

string | null · required

tax_ids

string[] · required

vat_id

string | null · required

organization_id

string · uuid · required

global_error

string | null · required

global_error_description

string | null · required

integration_id

string · uuid · required

icon_color

string · required

type

string · enum · required

Enum values:

inbox

accounting

integration_accounting_system

string · enum · required

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

access_actions

MembershipAccessActions[]

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

documents_to_process_count

number

QueueWithAnnotationSchemaDto[]

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

WorkspaceDto · required

WorkspaceSubjectIdMismatch

register_id_mismatch

boolean · required

tax_id_mismatch

boolean · required

WorkspaceType

string · enum

Enum values:

inbox

accounting

WorkspaceWithTokenDto

id

string · uuid · required

humanized_id

number · required

name

string · required

region

string · enum · required

Enum values:

cs

sk

uk

none

register_id

string | null · required

tax_id

string | null · required

tax_ids

string[] · required

vat_id

string | null · required

organization_id

string · uuid · required

global_error

string | null · required

global_error_description

string | null · required

integration_id

string · uuid · required

icon_color

string · required

type

string · enum · required

Enum values:

inbox

accounting

integration_accounting_system

string · enum · required

Enum values:

none

file-json

file-csv

file-xml

helios

flexibee

pohoda

file-xml-pohoda

token

string · required

access_actions

MembershipAccessActions[]

Enum values:

read

update

delete

upload-document

update-document

update-document-stage

lock-document

validate-annotations

documents_to_process_count

number

QueueWithAnnotationSchemaDto[]

WorkspaceWithTokenResponseDto

WorkspaceWithTokenDto · required

WorkspacesResponseDto

WorkspaceDto[] · required

array of response data

object · required

pagination

Schemas

AboPaymentDialogAlphanumericDataType

AboPaymentDialogNumericDataType

AboPaymentFileType

AboPaymentItemData

AboPaymentItemError

AboPaymentSPD

AcceptableSettingsKeys

AccountAutomationAnnotation

AccountAutomationAnnotationWithMetadata

AccountingAutomationDto

AccountingAutomationListResponseDto

AccountingAutomationResponseDto

AccountingAutomationRule

AccountingAutomationRuleAction

AccountingAutomationRuleParams

AccountingAutomationRuleParamsWithMetadata

AccountingAutomationRules

AccountingConfidenceFieldSettingDto

AccountingConfidenceThreshold

AccountingConfidenceValidationParamsDto

AccountingSystemDto

AccountingSystemEnum

AccuracyEntityKeyDto

AccuracyEntityTimeBucketDto

AccuracyFilterDto

AccuracyOrganizationPerDocumentDto

AccuracyOrganizationPerDocumentResponseDto

AccuracyOrganizationPerEntityDto

AccuracyOrganizationPerEntityResponseDto

AccuracyOrganizationPerQueueDto

AccuracyOrganizationPerVendorDto

AccuracyOrganizationPerVendorResponseDto

AccuracyOrganizationPerWorkspaceDto

AccuracyOrganizationPerWorkspaceResponseDto

AccuracyQueueDto

AccuracyTimeAggregatedDto

AccuracyTimeAggregatedResponseDto

AccuracyVendorQueueDto

AccuracyVendorTimeBucketDto

AccuracyVendorWorkspaceDto

AccuracyWorkspaceTimeBucketDto

AddUserRoleInQueueDto

AdvancedApprovalFeatureEnum

AdvancedApprovalStatusEnum

AffectedEntitiesCountDto

AffectedEntitiesCountResponseDto

AffectedQueueDto

AmountAggregateDto

AmountAggregatesDto

AmountAggregatesResponseDto

AnnotationCommentDto

AnnotationCommentResponseDto

AnnotationCommentThreadDto

AnnotationCommentThreadsResponseDto

AnnotationDateValueDto

AnnotationFieldDto

AnnotationFieldRenderOptionDto

AnnotationFieldRenderTypeEnum

AnnotationGlobalMessageDto

AnnotationGlobalStatusResponseDto

AnnotationNumericSuggestionDto

AnnotationNumericValueDto

AnnotationSchemaColumnsDto

AnnotationSchemaDto

AnnotationSchemaFieldDataTypeEnum

AnnotationSchemaFilterableFieldType

AnnotationSchemaNumericType

AnnotationSchemaResponse

AnnotationSchemaResponseDto

AnnotationSchemaSubfieldsDto

AnnotationSourceEnum

AnnotationSourceFiltersDto

AnnotationSourceType

AnnotationTableField

AnnotationTableRowDto

AnnotationTableValueTotalDto

AnnotationValidationMessageSeverityEnum

AnnotationValueDto

AnnotationValueInput