Queues

Get queue metadata by id or humanized id

GET

https://api.digitoo.ai

/api/v2/queues/{queue_id}

Get queue metadata by id or humanized id › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Get queue metadata by id or humanized id › query Parameters

include

QueueIncludeFields[]

Comma separated list of additional data which can be returned for each queue

Enum values:

access-actions

documents-to-process-count

settings

documents-count

features

workspace-metadata

extraction-evaluation

inbox

exclude

QueueExcludeFields[]

Comma separated list of data to be excluded

Enum values:

annotation-schema

schema_context

QueueSchemaContext · enum

Enum values:

user

queue

Get queue metadata by id or humanized id › Responses

QueueResponseDto

QueueWithAnnotationSchemaDto · required

GET/api/v2/queues/{queue_id}

curl https://api.digitoo.ai/api/v2/queues/:queue_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "humanized_id": 0,
    "name": "string",
    "created_at": "2025-01-01T00:00:00Z",
    "type": "issued-invoice",
    "currency": "string",
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "inbox_hash": "string",
    "inbox_hash_prefix": "main-workspace.received-invoices",
    "inbox": "string",
    "extraction_evaluation": "enabled",
    "automation_rules": "enabled",
    "accounting_automation_rules": "enabled",
    "extracted_pages_limit": 0,
    "annotation_schema": [
      {
        "type": "field",
        "message": "string",
        "message_key": "string",
        "key": "string",
        "datatype": "numeric",
        "numeric_type": "int",
        "default_value": "string",
        "hidden": false,
        "hide_register_value": false,
        "required": false,
        "autofill": [
          "string"
        ],
        "subfields": [
          {
            "key": "string",
            "datatype": "numeric",
            "message": "string",
            "hidden": false,
            "required": false,
            "default_value": "string",
            "hide_register_value": false,
            "pattern_matching": {
              "pattern": "string",
              "chunking_strategy": "ALL",
              "transform_chunks": [
                "string"
              ]
            },
            "updated_by_user": false,
            "formatting": "enabled"
          }
        ],
        "multivalue": false,
        "section_message_key": "string",
        "separator_key": "string",
        "multiline": false,
        "pattern_matching": "…",
        "updated_by_user": false,
        "formatting": "enabled",
        "max_length": 0
      }
    ],
    "access_actions": "read",
    "documents_to_process_count": 0,
    "settings": {
      "annotation_schema_columns": [
        {
          "message": "string",
          "key": "string",
          "datatype": "numeric",
          "visibility": "visible",
          "width": 0
        }
      ],
      "possible_schema_columns": [
        {
          "message": "…",
          "key": "…",
          "datatype": "…",
          "visibility": "…",
          "width": "…"
        }
      ],
      "user_schema_columns": [
        {
          "message": "…",
          "key": "…",
          "datatype": "…",
          "visibility": "…",
          "width": "…"
        }
      ]
    },
    "features": {
      "extraction": "enabled",
      "approval": "enabled",
      "relearning": "enabled",
      "isdoc_extraction": "enabled",
      "invalid_invoice_detection": "enabled",
      "bounce_email": "enabled",
      "ai_template_matching": "enabled",
      "ai_line_items_template_matching": "enabled",
      "ai_automated_accounting": "enabled",
      "advanced_approval": "enabled",
      "advanced_approval_auto_export": "enabled",
      "audit_log": "enabled",
      "split_document_by_qr_code": "enabled",
      "llm_accuracy_extraction": "enabled",
      "registers_frequent_items": "enabled",
      "show_to_validation": "enabled",
      "disable_approval_reject": "enabled",
      "approval_with_note": "enabled",
      "annotation_amounts_suggestions": "enabled",
      "context_template_matching": "enabled",
      "context_template_matching_line_items": "enabled",
      "delegate_approval": "enabled",
      "approve_assign_approval": "enabled",
      "skip_edi_description_ai_acc": "enabled",
      "ai_period_increment": "enabled",
      "auto_attach_email_attachments": "enabled"
    },
    "documents_count": {
      "by_stage": {
        "to_approve": 0,
        "to_validation": 0,
        "later": 0,
        "sent": 0,
        "deleted": 0,
        "rejected": 0,
        "spam": 0,
        "total": 0
      },
      "by_payment_status": {
        "unpaid": 0,
        "paid": 0,
        "paid_partially": 0,
        "to_pay": 0,
        "payment_order": 0,
        "past_due": 0
      }
    },
    "workspace": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "humanized_id": 0,
      "name": "string",
      "region": "cs",
      "register_id": "string",
      "tax_id": "string",
      "tax_ids": [
        "string"
      ],
      "vat_id": "string",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "global_error": "string",
      "global_error_description": "string",
      "integration_id": "550e8400-e29b-41d4-a716-446655440000",
      "access_actions": "read",
      "documents_to_process_count": 0,
      "queues": [
        {
          "id": "…",
          "humanized_id": "…",
          "name": "…",
          "created_at": "…",
          "type": "…",
          "currency": "…",
          "workspace_id": "…",
          "organization_id": "…",
          "inbox_hash": "…",
          "inbox_hash_prefix": "…",
          "inbox": "…",
          "extraction_evaluation": "…",
          "automation_rules": "…",
          "accounting_automation_rules": "…",
          "extracted_pages_limit": "…",
          "annotation_schema": "…",
          "access_actions": "…",
          "documents_to_process_count": "…",
          "settings": "…",
          "features": "…",
          "documents_count": "…",
          "workspace": "…",
          "extraction_evaluation_rule": {
            "document_confidence": 50,
            "fields": [
              {
                "confidence": 50,
                "field": "string",
                "validation_result": "string"
              }
            ]
          },
          "failed_import_settings": [
            {
              "recipient": "[email protected]"
            }
          ],
          "validations_settings": {}
        }
      ],
      "icon_color": "string",
      "type": "inbox",
      "integration_accounting_system": "none"
    },
    "extraction_evaluation_rule": "…",
    "failed_import_settings": "…",
    "validations_settings": "…"
  }
}

json

application/json

Remove queue and all its associated documents

DELETE

https://api.digitoo.ai

/api/v2/queues/{queue_id}

Remove queue and all its associated documents › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Remove queue and all its associated documents › Responses

No data returned

Patch queue metadata

PATCH

https://api.digitoo.ai

/api/v2/queues/{queue_id}

Patch queue metadata › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Patch queue metadata › Request Body

PatchQueueDto

name

string | null

inbox_hash_prefix

string

Patch queue metadata › Responses

QueueApiResponse

QueueWithAnnotationSchemaDto · required

PATCH/api/v2/queues/{queue_id}

curl https://api.digitoo.ai/api/v2/queues/:queue_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "string",
  "inbox_hash_prefix": "string"
}'

Example Request Body

{
  "name": "string",
  "inbox_hash_prefix": "string"
}

json

application/json

Example Responses

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "humanized_id": 0,
    "name": "string",
    "created_at": "2025-01-01T00:00:00Z",
    "type": "issued-invoice",
    "currency": "string",
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "inbox_hash": "string",
    "inbox_hash_prefix": "main-workspace.received-invoices",
    "inbox": "string",
    "extraction_evaluation": "enabled",
    "automation_rules": "enabled",
    "accounting_automation_rules": "enabled",
    "extracted_pages_limit": 0,
    "annotation_schema": [
      {
        "type": "field",
        "message": "string",
        "message_key": "string",
        "key": "string",
        "datatype": "numeric",
        "numeric_type": "int",
        "default_value": "string",
        "hidden": false,
        "hide_register_value": false,
        "required": false,
        "autofill": [
          "string"
        ],
        "subfields": [
          {
            "key": "string",
            "datatype": "numeric",
            "message": "string",
            "hidden": false,
            "required": false,
            "default_value": "string",
            "hide_register_value": false,
            "pattern_matching": {
              "pattern": "string",
              "chunking_strategy": "ALL",
              "transform_chunks": [
                "string"
              ]
            },
            "updated_by_user": false,
            "formatting": "enabled"
          }
        ],
        "multivalue": false,
        "section_message_key": "string",
        "separator_key": "string",
        "multiline": false,
        "pattern_matching": "…",
        "updated_by_user": false,
        "formatting": "enabled",
        "max_length": 0
      }
    ],
    "access_actions": "read",
    "documents_to_process_count": 0,
    "settings": {
      "annotation_schema_columns": [
        {
          "message": "string",
          "key": "string",
          "datatype": "numeric",
          "visibility": "visible",
          "width": 0
        }
      ],
      "possible_schema_columns": [
        {
          "message": "…",
          "key": "…",
          "datatype": "…",
          "visibility": "…",
          "width": "…"
        }
      ],
      "user_schema_columns": [
        {
          "message": "…",
          "key": "…",
          "datatype": "…",
          "visibility": "…",
          "width": "…"
        }
      ]
    },
    "features": {
      "extraction": "enabled",
      "approval": "enabled",
      "relearning": "enabled",
      "isdoc_extraction": "enabled",
      "invalid_invoice_detection": "enabled",
      "bounce_email": "enabled",
      "ai_template_matching": "enabled",
      "ai_line_items_template_matching": "enabled",
      "ai_automated_accounting": "enabled",
      "advanced_approval": "enabled",
      "advanced_approval_auto_export": "enabled",
      "audit_log": "enabled",
      "split_document_by_qr_code": "enabled",
      "llm_accuracy_extraction": "enabled",
      "registers_frequent_items": "enabled",
      "show_to_validation": "enabled",
      "disable_approval_reject": "enabled",
      "approval_with_note": "enabled",
      "annotation_amounts_suggestions": "enabled",
      "context_template_matching": "enabled",
      "context_template_matching_line_items": "enabled",
      "delegate_approval": "enabled",
      "approve_assign_approval": "enabled",
      "skip_edi_description_ai_acc": "enabled",
      "ai_period_increment": "enabled",
      "auto_attach_email_attachments": "enabled"
    },
    "documents_count": {
      "by_stage": {
        "to_approve": 0,
        "to_validation": 0,
        "later": 0,
        "sent": 0,
        "deleted": 0,
        "rejected": 0,
        "spam": 0,
        "total": 0
      },
      "by_payment_status": {
        "unpaid": 0,
        "paid": 0,
        "paid_partially": 0,
        "to_pay": 0,
        "payment_order": 0,
        "past_due": 0
      }
    },
    "workspace": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "humanized_id": 0,
      "name": "string",
      "region": "cs",
      "register_id": "string",
      "tax_id": "string",
      "tax_ids": [
        "string"
      ],
      "vat_id": "string",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "global_error": "string",
      "global_error_description": "string",
      "integration_id": "550e8400-e29b-41d4-a716-446655440000",
      "access_actions": "read",
      "documents_to_process_count": 0,
      "queues": [
        {
          "id": "…",
          "humanized_id": "…",
          "name": "…",
          "created_at": "…",
          "type": "…",
          "currency": "…",
          "workspace_id": "…",
          "organization_id": "…",
          "inbox_hash": "…",
          "inbox_hash_prefix": "…",
          "inbox": "…",
          "extraction_evaluation": "…",
          "automation_rules": "…",
          "accounting_automation_rules": "…",
          "extracted_pages_limit": "…",
          "annotation_schema": "…",
          "access_actions": "…",
          "documents_to_process_count": "…",
          "settings": "…",
          "features": "…",
          "documents_count": "…",
          "workspace": "…",
          "extraction_evaluation_rule": {
            "document_confidence": 50,
            "fields": [
              {
                "confidence": 50,
                "field": "string",
                "validation_result": "string"
              }
            ]
          },
          "failed_import_settings": [
            {
              "recipient": "[email protected]"
            }
          ],
          "validations_settings": {}
        }
      ],
      "icon_color": "string",
      "type": "inbox",
      "integration_accounting_system": "none"
    },
    "extraction_evaluation_rule": "…",
    "failed_import_settings": "…",
    "validations_settings": "…"
  }
}

json

application/json

Use advanced approval

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/advanced-approval

Set whether to use advanced approval

Use advanced approval › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use advanced approval › Request Body

QueueFeatureRequest

enabled

boolean · required

Use advanced approval › Responses

QueueFeatureResponse

enabled

boolean · required

Update annotation schema by queue

PUT

https://api.digitoo.ai

/api/v2/queues/{queue_id}/annotation-schema

Update annotation schema by queue › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Update annotation schema by queue › Request Body

UpdateAnnotationSchemaDto

AnnotationSchemaDto[] · minItems: 1 · required

Update annotation schema by queue › Responses

AnnotationSchemaResponse

AnnotationSchemaDto[] · required

PUT/api/v2/queues/{queue_id}/annotation-schema

curl https://api.digitoo.ai/api/v2/queues/:queue_id/annotation-schema \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "annotation_schema": [
    {
      "type": "field",
      "message": "string",
      "message_key": "string",
      "key": "string",
      "datatype": "numeric",
      "numeric_type": "int",
      "default_value": "string",
      "hidden": false,
      "hide_register_value": false,
      "required": false,
      "autofill": [
        "string"
      ],
      "subfields": [
        {
          "key": "string",
          "datatype": "numeric",
          "message": "string",
          "hidden": false,
          "required": false,
          "default_value": "string",
          "hide_register_value": false,
          "pattern_matching": {
            "pattern": "string",
            "chunking_strategy": "ALL",
            "transform_chunks": [
              "string"
            ]
          },
          "updated_by_user": false,
          "formatting": "enabled"
        }
      ],
      "multivalue": false,
      "section_message_key": "string",
      "separator_key": "string",
      "multiline": false,
      "pattern_matching": "…",
      "updated_by_user": false,
      "formatting": "enabled",
      "max_length": 0
    }
  ]
}'

Example Request Body

{
  "annotation_schema": [
    {
      "type": "field",
      "message": "string",
      "message_key": "string",
      "key": "string",
      "datatype": "numeric",
      "numeric_type": "int",
      "default_value": "string",
      "hidden": false,
      "hide_register_value": false,
      "required": false,
      "autofill": [
        "string"
      ],
      "subfields": [
        {
          "key": "string",
          "datatype": "numeric",
          "message": "string",
          "hidden": false,
          "required": false,
          "default_value": "string",
          "hide_register_value": false,
          "pattern_matching": {
            "pattern": "string",
            "chunking_strategy": "ALL",
            "transform_chunks": [
              "string"
            ]
          },
          "updated_by_user": false,
          "formatting": "enabled"
        }
      ],
      "multivalue": false,
      "section_message_key": "string",
      "separator_key": "string",
      "multiline": false,
      "pattern_matching": "…",
      "updated_by_user": false,
      "formatting": "enabled",
      "max_length": 0
    }
  ]
}

json

application/json

Example Responses

{
  "annotation_schema": [
    {
      "type": "field",
      "message": "string",
      "message_key": "string",
      "key": "string",
      "datatype": "numeric",
      "numeric_type": "int",
      "default_value": "string",
      "hidden": false,
      "hide_register_value": false,
      "required": false,
      "autofill": [
        "string"
      ],
      "subfields": [
        {
          "key": "string",
          "datatype": "numeric",
          "message": "string",
          "hidden": false,
          "required": false,
          "default_value": "string",
          "hide_register_value": false,
          "pattern_matching": {
            "pattern": "string",
            "chunking_strategy": "ALL",
            "transform_chunks": [
              "string"
            ]
          },
          "updated_by_user": false,
          "formatting": "enabled"
        }
      ],
      "multivalue": false,
      "section_message_key": "string",
      "separator_key": "string",
      "multiline": false,
      "pattern_matching": "…",
      "updated_by_user": false,
      "formatting": "enabled",
      "max_length": 0
    }
  ]
}

json

application/json

Patch annotation schema

PATCH

https://api.digitoo.ai

/api/v2/queues/{queue_id}/annotation-schema

Patch annotation schema › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Patch annotation schema › Request Body

PatchAnnotationSchemaBodyDto

PartialAnnotationSchemaFieldDto[] · required

Patch annotation schema › Responses

AnnotationSchemaResponse

AnnotationSchemaDto[] · required

PATCH/api/v2/queues/{queue_id}/annotation-schema

curl https://api.digitoo.ai/api/v2/queues/:queue_id/annotation-schema \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "annotation_fields": [
    {
      "key": "string",
      "options": [
        {
          "value": "string",
          "label": "string",
          "label_key": "string"
        }
      ],
      "multivalue": false,
      "message": "string",
      "formatting": "enabled",
      "hidden": false,
      "subfields": [
        {
          "key": "string",
          "multivalue": false,
          "formatting": "enabled",
          "hidden": false,
          "message": "string",
          "message_key": "string",
          "required": false,
          "datatype": "numeric",
          "default_value": "string",
          "hide_register_value": false,
          "autofill": [
            "string"
          ],
          "pattern_matching": {
            "pattern": "string",
            "chunking_strategy": "ALL",
            "transform_chunks": [
              "string"
            ]
          },
          "accuracy_threshold": 0,
          "max_length": 0
        }
      ],
      "section_message_key": "string",
      "separator_key": "string",
      "loose": false,
      "required": false,
      "datatype": "numeric",
      "autofill": [
        "string"
      ],
      "pattern_matching": "…",
      "default_value": "string",
      "hide_register_value": false,
      "multiline": false,
      "accuracy_threshold": 0,
      "required_for_auto_send": false,
      "frequent_items": {
        "enabled": false,
        "annotation": "string",
        "size": 0
      },
      "numeric_type": "int",
      "max_length": 0
    }
  ]
}'

Example Request Body

{
  "annotation_fields": [
    {
      "key": "string",
      "options": [
        {
          "value": "string",
          "label": "string",
          "label_key": "string"
        }
      ],
      "multivalue": false,
      "message": "string",
      "formatting": "enabled",
      "hidden": false,
      "subfields": [
        {
          "key": "string",
          "multivalue": false,
          "formatting": "enabled",
          "hidden": false,
          "message": "string",
          "message_key": "string",
          "required": false,
          "datatype": "numeric",
          "default_value": "string",
          "hide_register_value": false,
          "autofill": [
            "string"
          ],
          "pattern_matching": {
            "pattern": "string",
            "chunking_strategy": "ALL",
            "transform_chunks": [
              "string"
            ]
          },
          "accuracy_threshold": 0,
          "max_length": 0
        }
      ],
      "section_message_key": "string",
      "separator_key": "string",
      "loose": false,
      "required": false,
      "datatype": "numeric",
      "autofill": [
        "string"
      ],
      "pattern_matching": "…",
      "default_value": "string",
      "hide_register_value": false,
      "multiline": false,
      "accuracy_threshold": 0,
      "required_for_auto_send": false,
      "frequent_items": {
        "enabled": false,
        "annotation": "string",
        "size": 0
      },
      "numeric_type": "int",
      "max_length": 0
    }
  ]
}

json

application/json

Example Responses

{
  "annotation_schema": [
    {
      "type": "field",
      "message": "string",
      "message_key": "string",
      "key": "string",
      "datatype": "numeric",
      "numeric_type": "int",
      "default_value": "string",
      "hidden": false,
      "hide_register_value": false,
      "required": false,
      "autofill": [
        "string"
      ],
      "subfields": [
        {
          "key": "string",
          "datatype": "numeric",
          "message": "string",
          "hidden": false,
          "required": false,
          "default_value": "string",
          "hide_register_value": false,
          "pattern_matching": {
            "pattern": "string",
            "chunking_strategy": "ALL",
            "transform_chunks": [
              "string"
            ]
          },
          "updated_by_user": false,
          "formatting": "enabled"
        }
      ],
      "multivalue": false,
      "section_message_key": "string",
      "separator_key": "string",
      "multiline": false,
      "pattern_matching": "…",
      "updated_by_user": false,
      "formatting": "enabled",
      "max_length": 0
    }
  ]
}

json

application/json

Use audit log

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/audit-log

Set whether to use audit log

Use audit log › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use audit log › Request Body

QueueFeatureRequest

enabled

boolean · required

Use audit log › Responses

QueueFeatureResponse

enabled

boolean · required

Use auto-export

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/auto-export

Set whether to auto export documents

Use auto-export › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use auto-export › Request Body

QueueFeatureRequest

enabled

boolean · required

Use auto-export › Responses

QueueFeatureResponse

enabled

boolean · required

Use automated accounting

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/automated-accounting

Set whether to use automated accounting

Use automated accounting › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use automated accounting › Request Body

QueueFeatureRequest

enabled

boolean · required

Use automated accounting › Responses

QueueFeatureResponse

enabled

boolean · required

Use approval

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/basic-approval

Set whether to show to approve tab and use approval

Use approval › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use approval › Request Body

QueueFeatureRequest

enabled

boolean · required

Use approval › Responses

QueueFeatureResponse

enabled

boolean · required

Get queue documents

GET

https://api.digitoo.ai

/api/v2/queues/{queue_id}/documents

Get queue documents › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Get queue documents › query Parameters

SortQuery · style: deepObject · explode: true

exclude

ExcludeFieldsEnum[]

Comma separated list of additional data which can be excluded for each document.

Enum values:

tax-details

line-items

include

DocumentIncludeFieldsEnum[]

Enum values:

queue-metadata

workspace-metadata

locked-by

lock-status

approval-data

document-url

document-duplicities

workspace-subject-mismatch

formatting

AnnotationsFormattingEnum · enum

Enum: regular | simplified

Enum values:

regular

simplified

PaginationQuery · style: deepObject · explode: true

search

string

object · style: deepObject · explode: true

Filter documents by fields

Get queue documents › Responses

DocumentsApiResponse

DocumentWithIncludeExcludeMetadataDto[] · required

array of response data

object · required

pagination

GET/api/v2/queues/{queue_id}/documents

curl https://api.digitoo.ai/api/v2/queues/:queue_id/documents \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "confidence": 0,
      "internal_erp_id": "string",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z",
      "queue_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "received",
      "export_error": "string",
      "export_error_description": "string",
      "marked_as_exported_at": "string",
      "marked_as_exporting_at": "string",
      "marked_as_ready_to_export_at": "string",
      "page_count": 0,
      "file_name": "string",
      "extraction_error": "string",
      "line_items_visibility": "visible",
      "tax_detail_visibility": "visible",
      "email_id": "string",
      "received_from": "string",
      "inbox_status": "sorted",
      "export_allowed": false,
      "approve_allowed": false,
      "annotations_edit_allowed": false,
      "skip_allowed": false,
      "deletion_allowed": false,
      "initiate_approval_allowed": false,
      "move_allowed": false,
      "reset_allowed": false,
      "rejection_allowed": false,
      "queue_features": {
        "extraction": "enabled",
        "approval": "enabled",
        "relearning": "enabled",
        "isdoc_extraction": "enabled",
        "invalid_invoice_detection": "enabled",
        "bounce_email": "enabled",
        "ai_template_matching": "enabled",
        "ai_line_items_template_matching": "enabled",
        "ai_automated_accounting": "enabled",
        "advanced_approval": "enabled",
        "advanced_approval_auto_export": "enabled",
        "audit_log": "enabled",
        "split_document_by_qr_code": "enabled",
        "llm_accuracy_extraction": "enabled",
        "registers_frequent_items": "enabled",
        "show_to_validation": "enabled",
        "disable_approval_reject": "enabled",
        "approval_with_note": "enabled",
        "annotation_amounts_suggestions": "enabled",
        "context_template_matching": "enabled",
        "context_template_matching_line_items": "enabled",
        "delegate_approval": "enabled",
        "approve_assign_approval": "enabled",
        "skip_edi_description_ai_acc": "enabled",
        "ai_period_increment": "enabled",
        "auto_attach_email_attachments": "enabled"
      },
      "annotations": {
        "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
          }
        ]
      },
      "organization": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "humanized_id": 0,
        "name": "string",
        "status": "undetermined",
        "billable_features": {
          "enforce_features_constraints": false,
          "enforce_remaining_credits": false,
          "is_subscription_canceled": false,
          "workspace_count_limit": 0,
          "users_count_limit": 0,
          "approvers_count_limit": 0,
          "contract_period": "monthly",
          "billing": false,
          "tier": "trial",
          "contract_period_started_at": "string",
          "contract_period_ends_at": "string",
          "total_paid": 0,
          "features": {
            "comments": {
              "status": "enabled",
              "enabled_at": "string"
            },
            "inbox": "…",
            "audit_log": "…",
            "statistics": "…",
            "automation": "…",
            "accounting_automation": "…",
            "edi": "…",
            "ai_accounting": "…",
            "template_matching": "…",
            "adis": "…",
            "ares": "…",
            "vies": "…",
            "llm_accuracy_extraction": "…",
            "smart_storage": "…",
            "purchase_orders": "…",
            "digitoo_edi": "…",
            "two_factor_authentication": "…"
          },
          "support": {
            "premium_support": "…",
            "standard_support": "…",
            "phone_support": "…"
          },
          "integrations": [
            "string"
          ],
          "upgrade_requests": [
            {
              "user_id": "550e8400-e29b-41d4-a716-446655440000",
              "user_name": "string",
              "user_email": "string",
              "additional_approvers": 0,
              "requested_at": "string"
            }
          ],
          "individual": {
            "included_approvers": 0,
            "included_workspaces": 0,
            "included_users": 0,
            "included_documents": 0
          },
          "billing_credit_pools_enabled": false
        }
      },
      "workspace": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string",
        "icon_color": "string"
      },
      "queue": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "humanized_id": 0,
        "name": "string",
        "type": "issued-invoice"
      },
      "current_approver_ids": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "approved_by_current_user": false,
      "approval_process": [
        {
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "string",
          "status": "approved",
          "message": "string",
          "delegates": [
            {
              "user_id": "550e8400-e29b-41d4-a716-446655440000",
              "user_name": "string"
            }
          ]
        }
      ],
      "advanced_approval_status": "undetermined",
      "advanced_approval_route_name": "string",
      "advanced_approval_feature": "enabled",
      "locked_by_user": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "email": "[email protected]"
      },
      "lock_status": {
        "locked_at": "2025-01-01T00:00:00Z",
        "locked_by": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "string",
          "email": "[email protected]"
        },
        "locked": false,
        "locked_by_current_user": false,
        "locked_for_current_user": false
      },
      "current_approver_label": "string",
      "current_approver_labels": [
        "string"
      ],
      "payment_status": "paid",
      "stage": "to-validation",
      "rejection_reason": "string",
      "annotations_source": "ai",
      "annotations_source_type": "isdoc",
      "document_url": "string",
      "has_duplicities": false,
      "workspace_subject_mismatch": {
        "register_id_mismatch": false,
        "tax_id_mismatch": false
      },
      "has_attachments": false,
      "comments_count": 0,
      "last_status_change": {
        "changed_at": "2025-01-01T00:00:00Z",
        "changed_to": "received",
        "changed_by": "string",
        "type": "customer",
        "changed_by_id": "string",
        "changed_by_user_email": "string"
      },
      "status_change_history": [
        {
          "changed_at": "…",
          "changed_to": "…",
          "changed_by": "…",
          "type": "…",
          "changed_by_id": "…",
          "changed_by_user_email": "…"
        }
      ],
      "last_modified_at": "string",
      "last_updated_by_customer_at": "string",
      "last_updated_by_customer_by": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string",
        "email": "string"
      },
      "received_at": "string",
      "first_page_image": "string",
      "share_status": {
        "share_enabled": false,
        "share_url": "string",
        "created_at": "string",
        "expires_at": "string"
      },
      "page_images": [
        {
          "width": 0,
          "height": 0,
          "page_number": 0,
          "signed_url": "string",
          "mime_type": "string"
        }
      ],
      "page_edits_history": [
        {
          "pages": [
            {
              "rotation": 0,
              "page_index": 0
            }
          ],
          "parent_document_id": "550e8400-e29b-41d4-a716-446655440000",
          "edited_at": "2025-01-01T00:00:00Z",
          "edited_by": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "ocr_data": [
        {
          "index": 0,
          "region": {
            "left": 0,
            "top": 0,
            "width": 0,
            "height": 0,
            "page": 0
          },
          "value": "string",
          "raw_value": "string"
        }
      ],
      "received_from_name": "string",
      "uploaded_by_name": "string",
      "email_subject": "string",
      "advanced_approval_order": "ORDERED",
      "tags": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "string",
          "color": "#3F90FF"
        }
      ],
      "partial_total_paid": 0,
      "partial_total_remaining": 0,
      "register_labels": [
        {
          "key": "string",
          "label": "string"
        }
      ],
      "storage_location": {
        "name": "string",
        "path": "string",
        "parent_folder_url": "string"
      }
    }
  ],
  "pagination": {
    "page_number": 0,
    "page_size": 0,
    "total_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}

json

application/json

Get queue documents count

GET

https://api.digitoo.ai

/api/v2/queues/{queue_id}/documents-count

Get queue documents count › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Get queue documents count › Responses

QueueDocumentsCountResponseDto

DocumentsAggregatedCounts · required

Get external validation links

GET

https://api.digitoo.ai

/api/v2/queues/{queue_id}/external-validation-links

Get external validation links › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Get external validation links › Responses

ExternalValidationLinksResponseDto

object · required

Create or update external validation link

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/external-validation-links

Create or update external validation link › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Create or update external validation link › Request Body

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

Create or update external validation link › Responses

No data returned

Delete external validation link

DELETE

https://api.digitoo.ai

/api/v2/queues/{queue_id}/external-validation-links/{type}

Delete external validation link › path Parameters

type

ExternalValidationType · enum · required

Enum values:

initial_document_validation

document_validation

queue_id

required

A unique UUID or humanized id identifier

Delete external validation link › Responses

No data returned

Use extraction

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/extraction

Set whether to extract documents

Use extraction › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use extraction › Request Body

QueueFeatureRequest

enabled

boolean · required

Use extraction › Responses

QueueFeatureResponse

enabled

boolean · required

Use invalid invoice detection

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/invalid-invoice-detection

Set whether to use invalid invoice detection

Use invalid invoice detection › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use invalid invoice detection › Request Body

QueueFeatureRequest

enabled

boolean · required

Use invalid invoice detection › Responses

QueueFeatureResponse

enabled

boolean · required

Trigger ISDOC extraction

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/isdoc-extraction

Set whether to extract ISDOC data from PDF files if present rather than sending PDF to extraction

Trigger ISDOC extraction › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Trigger ISDOC extraction › Request Body

QueueFeatureRequest

enabled

boolean · required

Trigger ISDOC extraction › Responses

QueueFeatureResponse

enabled

boolean · required

Use line items template matching

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/line-items-template-matching

Set whether to use line items template matching. Template matching must be also enabled to use this feature

Use line items template matching › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use line items template matching › Request Body

QueueFeatureRequest

enabled

boolean · required

Use line items template matching › Responses

QueueFeatureResponse

enabled

boolean · required

Bulk update payment status of documents

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/payments

Bulk update payment status of documents › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Bulk update payment status of documents › Request Body

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

Bulk update payment status of documents › Responses

AffectedEntitiesCountResponseDto

AffectedEntitiesCountDto · required

Use QR splitting

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/qr-invoice-split

Set whether to split the invoices by page with QR code delimiter

Use QR splitting › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use QR splitting › Request Body

QueueFeatureRequest

enabled

boolean · required

Use QR splitting › Responses

QueueFeatureResponse

enabled

boolean · required

Get queue registers

GET

https://api.digitoo.ai

/api/v2/queues/{queue_id}/registers

Get queue registers › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Get queue registers › Responses

RegisterDto[]

RegisterDto

id

string · uuid · required

type

string · required

Use template matching

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/template-matching

Set whether to use template matching

Use template matching › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Use template matching › Request Body

QueueFeatureRequest

enabled

boolean · required

Use template matching › Responses

QueueFeatureResponse

enabled

boolean · required

Uploads files to a queue

POST

https://api.digitoo.ai

/api/v2/queues/{queue_id}/upload

Uploads files to a queue › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Uploads files to a queue › query Parameters

merge

boolean | null

Uploads files to a queue › Request Body

files

string[] · application/octet-stream · required

notify_webhook_url

string

A webhook URL that will receive updates about document status changes. See Callbacks tab section to get more info about webhook

UploadDocumentEmailDataDto

UploadDocumentAnnotationCommentsDataDto[]

Array of annotation comments data to be created for uploaded documents

Uploads files to a queue › Responses

UploadedFilesResponse

document_ids

string[] · required

POST/api/v2/queues/{queue_id}/upload

curl https://api.digitoo.ai/api/v2/queues/:queue_id/upload \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'files=string' \
  --form 'notify_webhook_url=string' \
  --form 'email={"subject":"string","body-plain":"string","body-html":"string","sender":"string"}' \
  --form 'annotation_comments_data={"content":[{"insert":{"mention":{"index":"string","denotation_char":"string","value":"string","id":"550e8400-e29b-41d4-a716-446655440000","type":"user"}},"attributes":{}}],"region":{"left":0,"top":0,"page":0}}'

Example Request Body

{
  "files": [
    "string"
  ],
  "notify_webhook_url": "string",
  "email": {
    "subject": "string",
    "body-plain": "string",
    "body-html": "string",
    "sender": "string"
  },
  "annotation_comments_data": [
    {
      "content": [
        {
          "insert": {
            "mention": {
              "index": "string",
              "denotation_char": "string",
              "value": "string",
              "id": "550e8400-e29b-41d4-a716-446655440000",
              "type": "user"
            }
          },
          "attributes": {}
        }
      ],
      "region": {
        "left": 0,
        "top": 0,
        "page": 0
      }
    }
  ]
}

text

multipart/form-data

Example Responses

{
  "document_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

json

application/json

Workspaces Memberships