Объекты

Card

Поля

• expandedCardExpanded
• permissionsObjectPermissionList
• accessstring

  Допустимые значения: wholepartial

• access_contactstring

  К кому обратиться за доступом (только при access=partial).

• aclobject
  Поля

  • verifybooleanобязательно
  • writebooleanобязательно
• categorystringобязательно
• category_confidencenumber | nullобязательно
• category_lockedbooleanобязательно
• category_reviewbooleanобязательно
• category_sourceCategorySource | nullобязательно
• collectionstringобязательно
• collection_idintegerобязательно
• collection_titlestring
• commentsarray of CardComment
• content_jsonContentJSON | null

  Содержимое редактора последней опубликованной версии. Поле может отсутствовать; тогда получите содержимое редактора из черновика (POST /v1/drafts с card_id).

• editing_lockEditingLock | null

  Действующая блокировка редактирования. Поле может отсутствовать; тогда редактор узнаёт, кто держит блокировку, из 409 cards.locked на POST /v1/cards/{card_id}/lock.

• created_atstring (date-time)обязательно
• days_since_verifiedintegerобязательно
• errorstring | nullобязательно
• eventsarray of CardEvent
• feedback_negintegerобязательно
• feedback_posintegerобязательно
• foldersarray of CardFolderRef

  Только в списке карточек: папки, в которых лежит карточка (видимые пользователю), с путями от корня коллекции. Пустой список — карточка не лежит ни в одной папке.

• has_tablesboolean

  Только в списке карточек.

• hidden_partsboolean
• idstringобязательно
• jobJob | null
• kindCardKindобязательно
• org_idintegerобязательно
• owner_activeboolean | null
• owner_idinteger | nullобязательно
• owner_namestring | nullобязательно
• pagesinteger | nullобязательно
• parserstring | nullобязательно

  Разборщик документа в виде нейтрального кода: document (полная структура: страницы, заголовки, таблицы, сканы страниц), pdf (текстовый слой PDF), docx, xlsx, csv, markdown, html, text. Список может расширяться.

• partsarray of CardPartобязательно
• sensitivebooleanобязательно
• sha256string | nullобязательно
• sizeintegerобязательно
• snoozed_atstring (date-time) | null
• snoozed_byinteger | null
• snoozed_untilstring | null
• source_changedbooleanобязательно
• source_pathstring | nullобязательно
• source_urlstring | nullобязательно
• statusstringобязательно

  Допустимые значения: processingreadyerrorarchived

• tablesarray of CardTable
• tagsarray of stringобязательно
• titlestringобязательно
• trustnumberобязательно
• trust_if_verifiednumber
• trust_partsTrustPartsобязательно
• updated_atstring (date-time)обязательно
• verificationVerificationобязательно
• verified_atstring (date-time) | nullобязательно
• verified_byinteger | nullобязательно
• verified_by_namestring | null
• verifier_idsarray of integerобязательно
• verifiersarray of object
  Поля

  • activebooleanобязательно
  • idintegerобязательно
  • namestringобязательно
• verify_interval_daysintegerобязательно
• versionintegerобязательно
• versionsarray of CardVersion
• source_archiveArchiveSource
• created_byinteger | null
• manual_optionsobject

  Ручные настройки разбора (предпросмотр).

• doc_kindDocKind | null

  Тип документа. null, если тип не определён (например, у карточек, проиндексированных до появления типов документов).

• doc_kind_confidencenumber | null

  Уверенность в типе документа, от 0 до 1.

• doc_kind_sourcestring | null

  Чем определён тип: правилами (rules), пользователем (manual) или автоматической классификацией. Список может расширяться: считайте незнакомое значение автоматической классификацией.

  Допустимые значения: rulesmanualnull

• invoiceDocInvoiceExtraction | null

  Поля счёта, кредит-ноты или чека (только для этих типов и только в карточке, не в списке). null, если у вас нет доступа ко всему документу: поля извлекаются из документа целиком.

• warningsarray of ReviewWarning

  Предупреждения разбора документа (ReviewWarning; только в карточке, не в списке).

• enrichmentCardEnrichmentStatus | null

  Статус обогащения (только в карточке, не в списке). Тип документа, поля счёта и финансовые записи добавляются в фоне после индексации и могут пересчитываться позже; в карточке они появляются, когда готовы. null — статус недоступен (карточка проиндексирована без фонового обогащения).

• external_idstring | null

  ID карточки в системе интегратора. Уникален в организации среди карточек, которые пришли не из источников; null — не задан. /v1/cards-by-external-id/{external_id} читает и заменяет карточку по нему.

  length ≤ 512

• metadataMetadata

Используется в

• GET/v1/cards/{card_id}Получить карточку с версиями, комментариями, таблицами и событиями
• PATCH/v1/cards/{card_id}Изменить карточку
• GET/v1/cards-by-external-id/{external_id}Получить карточку по внешнему ID
• POST/v1/cards/{card_id}/verifyПодтвердить актуальность карточки

Входит в

CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult