Skip to content
Sursa Developers

Objects

Card

Fields

  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    Allowed values: wholepartial

  • access_contactstring

    Whom to contact for access (only when access=partial).

  • aclobject
    Fields
    • verifybooleanrequired
    • writebooleanrequired
  • categorystringrequired
  • category_confidencenumber | nullrequired
  • category_lockedbooleanrequired
  • category_reviewbooleanrequired
  • category_sourceCategorySource | nullrequired
  • collectionstringrequired
  • collection_idintegerrequired
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    Editor content of the latest published version. The field can be absent; in that case, get the editor content from a draft (POST /v1/drafts with card_id).

  • editing_lockEditingLock | null

    Active editing lock. The field can be absent; in that case, the editor learns who holds the lock from 409 cards.locked on POST /v1/cards/{card_id}/lock.

  • created_atstring (date-time)required
  • days_since_verifiedintegerrequired
  • errorstring | nullrequired
  • eventsarray of CardEvent
  • feedback_negintegerrequired
  • feedback_posintegerrequired
  • foldersarray of CardFolderRef

    Card list only: the folders that contain the card (those visible to the user), with their paths from the collection root. An empty list means the card is not in any folder.

  • has_tablesboolean

    Card list only.

  • hidden_partsboolean
  • idstringrequired
  • jobJob | null
  • kindCardKindrequired
  • org_idintegerrequired
  • owner_activeboolean | null
  • owner_idinteger | nullrequired
  • owner_namestring | nullrequired
  • pagesinteger | nullrequired
  • parserstring | nullrequired

    Document parser as a neutral code: document (full structure: pages, headings, tables, scanned pages), pdf (the PDF text layer), docx, xlsx, csv, markdown, html, text. The list can grow.

  • partsarray of CardPartrequired
  • sensitivebooleanrequired
  • sha256string | nullrequired
  • sizeintegerrequired
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanrequired
  • source_pathstring | nullrequired
  • source_urlstring | nullrequired
  • statusstringrequired

    Allowed values: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringrequired
  • titlestringrequired
  • trustnumberrequired
  • trust_if_verifiednumber
  • trust_partsTrustPartsrequired
  • updated_atstring (date-time)required
  • verificationVerificationrequired
  • verified_atstring (date-time) | nullrequired
  • verified_byinteger | nullrequired
  • verified_by_namestring | null
  • verifier_idsarray of integerrequired
  • verifiersarray of object
    Fields
    • activebooleanrequired
    • idintegerrequired
    • namestringrequired
  • verify_interval_daysintegerrequired
  • versionintegerrequired
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    Manual parsing settings (preview).

  • doc_kindDocKind | null

    Document type. null if the type is not determined (for example, for cards indexed before document types were introduced).

  • doc_kind_confidencenumber | null

    Confidence in the document type, from 0 to 1.

  • doc_kind_sourcestring | null

    What determined the type: rules (rules), a user (manual) or automatic classification. The list can grow: treat an unknown value as automatic classification.

    Allowed values: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    Fields of an invoice, credit note or receipt (only for these types, and only in the card, not in the list). null if you do not have access to the whole document, because the fields are extracted from the whole document.

  • warningsarray of ReviewWarning

    Document parsing warnings (ReviewWarning; only in the card, not in the list).

  • enrichmentCardEnrichmentStatus | null

    Enrichment status (only in the card, not in the list). The document type, invoice fields and financial records are added in the background after indexing and can be recalculated later; they appear in the card when they are ready. null means no status is available (the card was indexed without background enrichment).

  • external_idstring | null

    ID of the card in the integrator's system. It is unique in the organization among cards that do not come from sources; null means it is not set. /v1/cards-by-external-id/{external_id} reads and replaces the card by it.

    length ≤ 512

  • metadataMetadata

Used by

Part of

CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult