Digitoo.ai
Digitoo API rev. 2.0.0

​Documents

Endpoint:https://api.digitoo.ai

​Get document metadata

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

​Get document metadata › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document metadata › query Parameters

  • includestring[]

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

    Enum values:
    queue-metadata
    workspace-metadata
    locked-by
    lock-status
    approval-data
    document-url
    document-duplicities
    last-status-change
  • excludestring[]

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

    Enum values:
    tax-details
    line-items
  • formattingstring · enum
    Enum values:
    regular
    simplified

​Get document metadata › Headers

  • share-keystring

    Share key for accessing resource

​Get document metadata › Responses

    • dataobject · required

​Get document annotations

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/annotations

​Get document annotations › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document annotations › Headers

  • share-keystring

    Share key for accessing resource

​Get document annotations › Responses

    • dataobject · required

      An object of annotations

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

​Get document annotation confidence

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/annotations-confidence

​Get document annotation confidence › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document annotation confidence › Headers

  • share-keystring

    Share key for accessing resource

​Get document annotation confidence › Responses

    • dataobject · required

      A list of annotations confidences

​Get document annotation values

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/annotations-values

​Get document annotation values › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document annotation values › Headers

  • share-keystring

    Share key for accessing resource

​Get document annotation values › Responses

    • dataobject · required

      A list of annotations values

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

​Get document attachments

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/attachments

​Get document attachments › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document attachments › Headers

  • share-keystring

    Share key for accessing resource

​Get document attachments › Responses

    • dataobject[] · required

​Add attachment to document

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/attachments

​Add attachment to document › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Add attachment to document › Request Body

  • filesstring[] · required

​Add attachment to document › Responses

    No schema specified

​Get document audit log

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/audit-log

​Get document audit log › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document audit log › query Parameters

  • pageobject · style: deepObject · explode: true

​Get document audit log › Headers

  • share-keystring

    Share key for accessing resource

​Get document audit log › Responses

    • dataobject[] · required

      array of response data

    • paginationrequired

      pagination

​Get document audit logs as CSV file

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/audit-log/csv

​Get document audit logs as CSV file › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document audit logs as CSV file › Headers

  • share-keystring

    Share key for accessing resource

​Get document audit logs as CSV file › Responses

    No schema specified

​Get document audit log with UI ready humanized messages

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/audit-log/humanized

​Get document audit log with UI ready humanized messages › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document audit log with UI ready humanized messages › query Parameters

  • pageobject · style: deepObject · explode: true

​Get document audit log with UI ready humanized messages › Headers

  • share-keystring

    Share key for accessing resource

​Get document audit log with UI ready humanized messages › Responses

    • dataobject[] · required

      array of response data

    • paginationrequired

      pagination

    • documentobject · required

​Update single basic annotation

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/basic-annotation

​Update single basic annotation › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Update single basic annotation › Request Body

  • fieldstring · required

    Annotation field to be updated

  • valuerequired

    Annotation value object to be set

  • indexnumber

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

​Update single basic annotation › Responses

    • dataobject · required

​Get document email

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/email

​Get document email › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document email › Headers

  • share-keystring

    Share key for accessing resource

​Get document email › Responses

    • dataobject · required

​Enqueue document to extraction

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/enqueue-to-extraction

​Enqueue document to extraction › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Enqueue document to extraction › Responses

    No schema specified

​Exports document to a specified format

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/export

​Exports document to a specified format › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Exports document to a specified format › query Parameters

  • typestring · enum · required

    File export type

    Enum values:
    csv
    pdf
    pdf_with_isdoc
    png
    isdoc
    xml
    xlsx
  • export_columns_optionsstring · enum
    Enum values:
    visible
    all
  • export_file_name_optionsstring[]
    Enum values:
    sender_name
    sender_register_id
    invoice_id
    internal_erp_id
    original_filename
  • export_line_itemsstring · enum
    Enum values:
    true
    false

​Exports document to a specified format › Headers

  • share-keystring

    Share key for accessing resource

​Exports document to a specified format › Responses

    string

​Get initial annotations of document

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/initial-annotations

​Get initial annotations of document › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get initial annotations of document › Headers

  • share-keystring

    Share key for accessing resource

​Get initial annotations of document › Responses

    • dataobject · required

      An object of annotations

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

​Get initial annotation values of document

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/initial-annotations-values

​Get initial annotation values of document › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get initial annotation values of document › Headers

  • share-keystring

    Share key for accessing resource

​Get initial annotation values of document › Responses

    • dataobject · required

      A list of annotations values

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

​Change document internal ERP ID

PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/internal-erp-id

​Change document internal ERP ID › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Change document internal ERP ID › Request Body

  • internal_erp_idstring | null · required

​Change document internal ERP ID › Responses

    No schema specified

​Get document OCR data

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/ocr-data

​Get document OCR data › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Get document OCR data › Headers

  • share-keystring

    Share key for accessing resource

​Get document OCR data › Responses

    • dataobject[] · required

​Download document original invoice file

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/original-file

​Download document original invoice file › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Download document original invoice file › Headers

  • share-keystring

    Share key for accessing resource

​Download document original invoice file › Responses

    string

​Sets payment status of the document

PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/payment-status

​Sets payment status of the document › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Sets payment status of the document › Request Body

  • statusrequired

​Sets payment status of the document › Responses

    No schema specified

​Enable or disable share status of document

PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/share-status

​Enable or disable share status of document › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Enable or disable share status of document › Request Body

  • share_enabledboolean · required

    True for enable, false for disable

​Enable or disable share status of document › Responses

    • dataobject · required

​Change document status

PATCH
https://api.digitoo.ai
/api/v2/documents/{document_id}/status

​Change document status › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Change document status › Request Body

  • statusrequired

    New document status

  • internal_erp_idstring | null

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

  • export_errorstring | null

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

  • export_error_descriptionstring | null

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

​Change document status › Responses

    No schema specified

​Update single table annotation

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-annotation

​Update single table annotation › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Update single table annotation › Request Body

  • fieldstring · required

    Annotation field to be updated

  • table_keyrequired

    Annotation table to be updated

  • row_indexnumber · required

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

  • valuerequired

    Annotation value object to be set

  • indexnumber

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

​Update single table annotation › Responses

    • dataobject · required

​Append new annotation table row

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/append-row

​Append new annotation table row › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Append new annotation table row › Request Body

  • table_keyrequired
    Example: line_items

​Append new annotation table row › Responses

    • dataobject · required

​Duplicate annotation table row

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/duplicate

​Duplicate annotation table row › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Duplicate annotation table row › Request Body

  • table_keyrequired
    Example: line_items
  • indexnumber · required

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

​Duplicate annotation table row › Responses

    • dataobject · required

​Removes all annotation table rows

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/remove-all

​Removes all annotation table rows › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Removes all annotation table rows › Request Body

  • table_keyrequired
    Example: line_items

​Removes all annotation table rows › Responses

    • dataobject · required

​Removes annotation table row

POST
https://api.digitoo.ai
/api/v2/documents/{document_id}/table-fields/remove-row

​Removes annotation table row › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

​Removes annotation table row › Request Body

  • table_keyrequired
    Example: line_items
  • indexnumber · required

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

​Removes annotation table row › Responses

    • dataobject · required
RegistersWebhooks