Objecten
Card
Velden
expandedCardExpandedpermissionsObjectPermissionListaccessstringToegestane waarden:
wholepartialaccess_contactstringBij wie je toegang kunt aanvragen (alleen bij
access=partial).aclobjectVelden
verifybooleanverplichtwritebooleanverplicht
categorystringverplichtcategory_confidencenumber | nullverplichtcategory_lockedbooleanverplichtcategory_reviewbooleanverplichtcollectionstringverplichtcollection_idintegerverplichtcollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullEditorinhoud van de laatste gepubliceerde versie. Het veld kan ontbreken; haal de editorinhoud dan uit een concept (
POST /v1/draftsmetcard_id).editing_lockEditingLock | nullActieve bewerkingsvergrendeling. Het veld kan ontbreken; de editor ziet dan wie de vergrendeling heeft aan
409 cards.lockedopPOST /v1/cards/{card_id}/lock.created_atstring (date-time)verplichtdays_since_verifiedintegerverplichterrorstring | nullverplichteventsarray of CardEventfeedback_negintegerverplichtfeedback_posintegerverplichtfoldersarray of CardFolderRefAlleen in de lijst van kaarten: de mappen die de kaart bevatten (die de gebruiker ziet), met hun paden vanaf het hoofdniveau van de collectie. Een lege lijst betekent dat de kaart in geen enkele map staat.
has_tablesbooleanAlleen in de lijst van kaarten.
hidden_partsbooleanidstringverplichtjobJob | nullorg_idintegerverplichtowner_activeboolean | nullowner_idinteger | nullverplichtowner_namestring | nullverplichtpagesinteger | nullverplichtparserstring | nullverplichtDocumentparser als neutrale code:
document(volledige structuur: pagina’s, koppen, tabellen, gescande pagina’s),pdf(de tekstlaag van de PDF),docx,xlsx,csv,markdown,html,text. De lijst kan groeien.sensitivebooleanverplichtsha256string | nullverplichtsizeintegerverplichtsnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanverplichtsource_pathstring | nullverplichtsource_urlstring | nullverplichtstatusstringverplichtToegestane waarden:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringverplichttitlestringverplichttrustnumberverplichttrust_if_verifiednumberupdated_atstring (date-time)verplichtverified_atstring (date-time) | nullverplichtverified_byinteger | nullverplichtverified_by_namestring | nullverifier_idsarray of integerverplichtverifiersarray of objectVelden
activebooleanverplichtidintegerverplichtnamestringverplicht
verify_interval_daysintegerverplichtversionintegerverplichtversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectHandmatige instellingen voor het parseren (voorbeeld).
doc_kindDocKind | nullDocumenttype.
nullals het type niet is bepaald (bijvoorbeeld bij kaarten die zijn geïndexeerd voordat er documenttypen waren).doc_kind_confidencenumber | nullZekerheid over het documenttype, van 0 tot 1.
doc_kind_sourcestring | nullWat het type heeft bepaald: regels (
rules), een gebruiker (manual) of automatische classificatie. De lijst kan groeien: behandel een onbekende waarde als automatische classificatie.Toegestane waarden:
rulesmanualnullinvoiceDocInvoiceExtraction | nullVelden van een factuur, creditnota of bon (alleen voor deze typen, en alleen in de kaart, niet in de lijst).
nullals je geen toegang hebt tot het hele document, want de velden worden uit het hele document gehaald.warningsarray of ReviewWarningWaarschuwingen bij het parseren van het document (
ReviewWarning; alleen in de kaart, niet in de lijst).enrichmentCardEnrichmentStatus | nullVerrijkingsstatus (alleen in de kaart, niet in de lijst). Het documenttype, de factuurvelden en de financiële records worden na het indexeren op de achtergrond toegevoegd en kunnen later opnieuw worden berekend; ze verschijnen in de kaart zodra ze klaar zijn.
nullbetekent dat er geen status beschikbaar is (de kaart is geïndexeerd zonder verrijking op de achtergrond).external_idstring | nullID van de kaart in het systeem van de integrator. Uniek in de organisatie onder kaarten die niet uit bronnen komen;
nullbetekent dat die niet is ingesteld./v1/cards-by-external-id/{external_id}leest en vervangt de kaart op basis daarvan.length ≤ 512
metadataMetadata
Gebruikt door
- GET
/v1/cards/{card_id}Kaart ophalen met versies, opmerkingen, tabellen en events - PATCH
/v1/cards/{card_id}Kaart bijwerken - GET
/v1/cards-by-external-id/{external_id}Kaart ophalen op externe ID - POST
/v1/cards/{card_id}/verifyBevestigen dat een kaart actueel is
Onderdeel van
CardListJobActionResultJobExpandedJobWithCardPushDocumentStatusExpandedReindexResultTasksDetailTasksLegacyTextCardResultUploadResult