Digitoo.ai
Digitoo API rev. 2.0.0

​Queues

Endpoint:https://api.digitoo.ai

​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_idrequired

    A unique UUID or humanized id identifier

​Get queue metadata by id or humanized id › query Parameters

  • includestring[]

    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
  • excludestring[]

    Comma separated list of data to be excluded

    Enum values:
    annotation-schema
  • schema_contextstring · enum
    Enum values:
    user
    queue

​Get queue metadata by id or humanized id › Responses

    • dataobject · required

​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_idrequired

    A unique UUID or humanized id identifier

​Remove queue and all its associated documents › Responses

    No schema specified

​Patch queue metadata

PATCH
https://api.digitoo.ai
/api/v2/queues/{queue_id}

​Patch queue metadata › path Parameters

  • queue_idrequired

    A unique UUID or humanized id identifier

​Patch queue metadata › Request Body

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

​Patch queue metadata › Responses

    • dataobject · required

​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_idrequired

    A unique UUID or humanized id identifier

​Use advanced approval › Request Body

  • enabledboolean · required

​Use advanced approval › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Update annotation schema by queue › Request Body

  • annotation_schemaobject[] · minItems: 1 · required
    Example: [{"type":"subtitle","message":"Hlavní sekce","sectionMessageKey":"payment_details"},{"type":"field","key":"sender_name","message":"Sender Name","datatype":"alphanumeric","hidden":false,"autofill":["sender_tax_id"]},{"type":"separator","separatorKey":"separator-1"},{"type":"field","key":"tax_detail","subfields":[{"key":"rate","datatype":"numeric"}]},{"type":"separator","separatorKey":"separator-2"},{"type":"field","key":"line_items","subfields":[{"key":"description","datatype":"alphanumeric","defaultValue":"Hello"}]}]

​Update annotation schema by queue › Responses

    • annotation_schemaobject[] · required

      An annotation schema

​Patch annotation schema

PATCH
https://api.digitoo.ai
/api/v2/queues/{queue_id}/annotation-schema

​Patch annotation schema › path Parameters

  • queue_idrequired

    A unique UUID or humanized id identifier

​Patch annotation schema › Request Body

  • annotation_fieldsobject[] · required

​Patch annotation schema › Responses

    • annotation_schemaobject[] · required

      An annotation schema

​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_idrequired

    A unique UUID or humanized id identifier

​Use audit log › Request Body

  • enabledboolean · required

​Use audit log › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Use auto-export › Request Body

  • enabledboolean · required

​Use auto-export › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Use automated accounting › Request Body

  • enabledboolean · required

​Use automated accounting › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Use approval › Request Body

  • enabledboolean · required

​Use approval › Responses

    • enabledboolean · required

​Get queue documents

GET
https://api.digitoo.ai
/api/v2/queues/{queue_id}/documents

​Get queue documents › path Parameters

  • queue_idrequired

    A unique UUID or humanized id identifier

​Get queue documents › query Parameters

  • sortobject · style: deepObject · explode: true
  • excludestring[]

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

    Enum values:
    tax-details
    line-items
  • includestring[]
    Enum values:
    queue-metadata
    workspace-metadata
    locked-by
    lock-status
    approval-data
    document-url
    document-duplicities
    last-status-change
  • formattingstring · enum

    Enum: regular | simplified

    Enum values:
    regular
    simplified
  • pageobject · style: deepObject · explode: true
  • searchstring
  • filtersobject · style: deepObject · explode: true

    Filter documents by fields

​Get queue documents › Responses

    • dataobject[] · required

      array of response data

    • paginationrequired

      pagination

​Get queue documents count

GET
https://api.digitoo.ai
/api/v2/queues/{queue_id}/documents-count

​Get queue documents count › path Parameters

  • queue_idrequired

    A unique UUID or humanized id identifier

​Get queue documents count › Responses

    • datarequired

      Documents aggregated counts for queue

​Use extraction

POST
https://api.digitoo.ai
/api/v2/queues/{queue_id}/extraction

Set whether to extract documents

​Use extraction › path Parameters

  • queue_idrequired

    A unique UUID or humanized id identifier

​Use extraction › Request Body

  • enabledboolean · required

​Use extraction › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Use invalid invoice detection › Request Body

  • enabledboolean · required

​Use invalid invoice detection › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Trigger ISDOC extraction › Request Body

  • enabledboolean · required

​Trigger ISDOC extraction › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Use line items template matching › Request Body

  • enabledboolean · required

​Use line items template matching › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Bulk update payment status of documents › Request Body

  • filtersobject · required
  • payment_statusrequired
  • searchstring | null

​Bulk update payment status of documents › Responses

    • dataobject · 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_idrequired

    A unique UUID or humanized id identifier

​Use QR splitting › Request Body

  • enabledboolean · required

​Use QR splitting › Responses

    • enabledboolean · required

​Get queue registers

GET
https://api.digitoo.ai
/api/v2/queues/{queue_id}/registers

​Get queue registers › path Parameters

  • queue_idrequired

    A unique UUID or humanized id identifier

​Get queue registers › Responses

    object[]
    • idstring · uuid · required
    • typestring · 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_idrequired

    A unique UUID or humanized id identifier

​Use template matching › Request Body

  • enabledboolean · required

​Use template matching › Responses

    • enabledboolean · 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_idrequired

    A unique UUID or humanized id identifier

​Uploads files to a queue › query Parameters

  • mergeboolean | null

​Uploads files to a queue › Request Body

  • filesstring[] · required
  • notify_webhook_urlstring

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

  • emailobject

​Uploads files to a queue › Responses

    • document_idsstring[] · required
WorkspacesRegisters