Перейти до вмісту
Sursa Developers

Об’єкти

CardList

Поля

array of 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

Використовується в