Обекти

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}Получаване на карта по външен идентификатор
• POST/v1/cards/{card_id}/verifyПотвърждаване, че картата е актуална

Част от

CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult