Обекти
CardList
Полета
expandedCardExpandedpermissionsObjectPermissionListaccessstringДопустими стойности:
wholepartialaccess_contactstringС кого да се свържете за достъп (само при
access=partial).aclobjectПолета
verifybooleanзадължителноwritebooleanзадължително
categorystringзадължителноcategory_confidencenumber | nullзадължителноcategory_lockedbooleanзадължителноcategory_reviewbooleanзадължителноcollectionstringзадължителноcollection_idintegerзадължителноcollection_titlestringcommentsarray of CardCommentcontent_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 CardEventfeedback_negintegerзадължителноfeedback_posintegerзадължителноfoldersarray of CardFolderRefСамо в списъка с карти: папките, които съдържат картата (видимите за потребителя), с пътищата им от корена на колекцията. Празен списък означава, че картата не е в никоя папка.
has_tablesbooleanСамо в списъка с карти.
hidden_partsbooleanidstringзадължителноjobJob | nullorg_idintegerзадължителноowner_activeboolean | nullowner_idinteger | nullзадължителноowner_namestring | nullзадължителноpagesinteger | nullзадължителноparserstring | nullзадължителноНачин на разбор на документа като неутрален код:
document(пълна структура: страници, заглавия, таблици, сканирани страници),pdf(текстовият слой на PDF),docx,xlsx,csv,markdown,html,text. Списъкът може да се разширява.sensitivebooleanзадължителноsha256string | nullзадължителноsizeintegerзадължителноsnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanзадължителноsource_pathstring | nullзадължителноsource_urlstring | nullзадължителноstatusstringзадължителноДопустими стойности:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringзадължителноtitlestringзадължителноtrustnumberзадължителноtrust_if_verifiednumberupdated_atstring (date-time)задължителноverified_atstring (date-time) | nullзадължителноverified_byinteger | nullзадължителноverified_by_namestring | nullverifier_idsarray of integerзадължителноverifiersarray of objectПолета
activebooleanзадължителноidintegerзадължителноnamestringзадължително
verify_interval_daysintegerзадължителноversionintegerзадължителноversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectРъчни настройки на разбора (преглед на разбора).
doc_kindDocKind | nullТип на документа.
null, ако типът не е определен (например за карти, индексирани преди въвеждането на типовете документи).doc_kind_confidencenumber | nullСтепен на увереност в типа на документа, от 0 до 1.
doc_kind_sourcestring | nullКакво е определило типа: правила (
rules), потребител (manual) или автоматична класификация. Списъкът може да се разширява: третирайте непозната стойност като автоматична класификация.Допустими стойности:
rulesmanualnullinvoiceDocInvoiceExtraction | nullПолета на фактура, кредитно известие или касова бележка (само за тези типове и само в картата, не в списъка).
null, ако нямате достъп до целия документ, защото полетата се извличат от целия документ.warningsarray of ReviewWarningПредупреждения при разбора на документа (
ReviewWarning; само в картата, не в списъка).enrichmentCardEnrichmentStatus | nullСтатус на обогатяването (само в картата, не в списъка). Типът на документа, полетата на фактурата и финансовите записи се добавят във фонов режим след индексирането и може да бъдат преизчислени по-късно; те се появяват в картата, когато са готови.
nullозначава, че няма наличен статус (картата е индексирана без фоново обогатяване).external_idstring | nullID на картата в системата на интегратора. Уникален е в организацията сред картите, които не идват от източници;
nullозначава, че не е зададен./v1/cards-by-external-id/{external_id}чете и заменя картата по него.length ≤ 512
metadataMetadata