Objektid
Card
Väljad
expandedCardExpandedpermissionsObjectPermissionListaccessstringLubatud väärtused:
wholepartialaccess_contactstringKelle poole juurdepääsu saamiseks pöörduda (ainult kui
access=partial).aclobjectVäljad
verifybooleankohustuslikwritebooleankohustuslik
categorystringkohustuslikcategory_confidencenumber | nullkohustuslikcategory_lockedbooleankohustuslikcategory_reviewbooleankohustuslikcollectionstringkohustuslikcollection_idintegerkohustuslikcollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullViimase avaldatud versiooni redaktori sisu. Väli võib puududa; sel juhul saate redaktori sisu mustandist (
POST /v1/draftskoos väljagacard_id).editing_lockEditingLock | nullAktiivne redigeerimislukk. Väli võib puududa; sel juhul saab redaktor teada, kellel lukk on, vastusest
409 cards.lockedtoimingulePOST /v1/cards/{card_id}/lock.created_atstring (date-time)kohustuslikdays_since_verifiedintegerkohustuslikerrorstring | nullkohustuslikeventsarray of CardEventfeedback_negintegerkohustuslikfeedback_posintegerkohustuslikfoldersarray of CardFolderRefAinult kaartide loendis: kaustad, mis kaarti sisaldavad (kasutajale nähtavad), koos nende teedega kogu juurest. Tühi loend tähendab, et kaart ei ole üheski kaustas.
has_tablesbooleanAinult kaartide loendis.
hidden_partsbooleanidstringkohustuslikjobJob | nullorg_idintegerkohustuslikowner_activeboolean | nullowner_idinteger | nullkohustuslikowner_namestring | nullkohustuslikpagesinteger | nullkohustuslikparserstring | nullkohustuslikDokumendi parser neutraalse koodina:
document(täielik struktuur: lehed, pealkirjad, tabelid, skannitud lehed),pdf(PDF-i tekstikiht),docx,xlsx,csv,markdown,html,text. Loend võib täieneda.sensitivebooleankohustusliksha256string | nullkohustusliksizeintegerkohustusliksnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleankohustusliksource_pathstring | nullkohustusliksource_urlstring | nullkohustuslikstatusstringkohustuslikLubatud väärtused:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringkohustusliktitlestringkohustusliktrustnumberkohustusliktrust_if_verifiednumberupdated_atstring (date-time)kohustuslikverified_atstring (date-time) | nullkohustuslikverified_byinteger | nullkohustuslikverified_by_namestring | nullverifier_idsarray of integerkohustuslikverifiersarray of objectVäljad
activebooleankohustuslikidintegerkohustusliknamestringkohustuslik
verify_interval_daysintegerkohustuslikversionintegerkohustuslikversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectParsimise käsitsi seaded (eelvaade).
doc_kindDocKind | nullDokumendi tüüp.
null, kui tüüp ei ole määratud (näiteks kaartidel, mis indekseeriti enne dokumenditüüpide kasutuselevõttu).doc_kind_confidencenumber | nullDokumendi tüübi kindlusaste vahemikus 0 kuni 1.
doc_kind_sourcestring | nullMis tüübi määras: reeglid (
rules), kasutaja (manual) või automaatne liigitamine. Loend võib täieneda: käsitlege tundmatut väärtust automaatse liigitamisena.Lubatud väärtused:
rulesmanualnullinvoiceDocInvoiceExtraction | nullArve, kreeditarve või kviitungi väljad (ainult nende tüüpide puhul ja ainult kaardil, mitte loendis).
null, kui teil puudub juurdepääs kogu dokumendile, sest väljad eraldatakse kogu dokumendist.warningsarray of ReviewWarningDokumendi parsimise hoiatused (
ReviewWarning; ainult kaardil, mitte loendis).enrichmentCardEnrichmentStatus | nullRikastamise olek (ainult kaardil, mitte loendis). Dokumendi tüüp, arve väljad ja finantskirjed lisatakse taustal pärast indekseerimist ning neid võidakse hiljem uuesti arvutada; need ilmuvad kaardile, kui on valmis.
nulltähendab, et olek ei ole saadaval (kaart indekseeriti ilma taustal rikastamiseta).external_idstring | nullKaardi ID integraatori süsteemis. See on organisatsioonis unikaalne kaartide seas, mis ei pärine allikatest;
nulltähendab, et see ei ole määratud./v1/cards-by-external-id/{external_id}loeb ja asendab kaardi selle järgi.length ≤ 512
metadataMetadata
Kasutatakse
- GET
/v1/cards/{card_id}Kaardi pärimine koos versioonide, kommentaaride, tabelite ja sündmustega - PATCH
/v1/cards/{card_id}Kaardi muutmine - GET
/v1/cards-by-external-id/{external_id}Kaardi pärimine välise ID järgi - POST
/v1/cards/{card_id}/verifyKaardi ajakohasuse kinnitamine
Sisaldub
CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult