Objectes
CardList
Camps
expandedCardExpandedpermissionsObjectPermissionListaccessstringValors permesos:
wholepartialaccess_contactstringPersona a qui cal adreçar-se per obtenir accés (només quan
access=partial).aclobjectCamps
verifybooleanobligatoriwritebooleanobligatori
categorystringobligatoricategory_confidencenumber | nullobligatoricategory_lockedbooleanobligatoricategory_reviewbooleanobligatoricollectionstringobligatoricollection_idintegerobligatoricollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullContingut de l’editor de l’última versió publicada. El camp pot no ser-hi; en aquest cas, obteniu el contingut de l’editor d’un esborrany (
POST /v1/draftsambcard_id).editing_lockEditingLock | nullBloqueig d’edició actiu. El camp pot no ser-hi; en aquest cas, l’editor sap qui té el bloqueig per la resposta
409 cards.lockeddePOST /v1/cards/{card_id}/lock.created_atstring (date-time)obligatoridays_since_verifiedintegerobligatorierrorstring | nullobligatorieventsarray of CardEventfeedback_negintegerobligatorifeedback_posintegerobligatorifoldersarray of CardFolderRefNomés a la llista d’entrades: les carpetes que contenen l’entrada (les que l’usuari pot veure), amb els seus camins des de l’arrel de la col·lecció. Una llista buida vol dir que l’entrada no és a cap carpeta.
has_tablesbooleanNomés a la llista d’entrades.
hidden_partsbooleanidstringobligatorijobJob | nullorg_idintegerobligatoriowner_activeboolean | nullowner_idinteger | nullobligatoriowner_namestring | nullobligatoripagesinteger | nullobligatoriparserstring | nullobligatoriAnalitzador del document com a codi neutre:
document(estructura completa: pàgines, títols, taules, pàgines escanejades),pdf(la capa de text del PDF),docx,xlsx,csv,markdown,html,text. La llista pot créixer.sensitivebooleanobligatorisha256string | nullobligatorisizeintegerobligatorisnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanobligatorisource_pathstring | nullobligatorisource_urlstring | nullobligatoristatusstringobligatoriValors permesos:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringobligatorititlestringobligatoritrustnumberobligatoritrust_if_verifiednumberupdated_atstring (date-time)obligatoriverified_atstring (date-time) | nullobligatoriverified_byinteger | nullobligatoriverified_by_namestring | nullverifier_idsarray of integerobligatoriverifiersarray of objectCamps
activebooleanobligatoriidintegerobligatorinamestringobligatori
verify_interval_daysintegerobligatoriversionintegerobligatoriversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectConfiguració manual de l’anàlisi (previsualització).
doc_kindDocKind | nullTipus de document.
nullsi el tipus no s’ha determinat (per exemple, en entrades indexades abans que s’introduïssin els tipus de document).doc_kind_confidencenumber | nullGrau de certesa del tipus de document, de 0 a 1.
doc_kind_sourcestring | nullQuè ha determinat el tipus: regles (
rules), un usuari (manual) o la classificació automàtica. La llista pot créixer: tracteu un valor desconegut com a classificació automàtica.Valors permesos:
rulesmanualnullinvoiceDocInvoiceExtraction | nullCamps d’una factura, una nota d’abonament o un rebut (només per a aquests tipus, i només a l’entrada, no a la llista).
nullsi no teniu accés a tot el document, perquè els camps s’extreuen del document sencer.warningsarray of ReviewWarningAvisos de l’anàlisi del document (
ReviewWarning; només a l’entrada, no a la llista).enrichmentCardEnrichmentStatus | nullEstat de l’enriquiment (només a l’entrada, no a la llista). El tipus de document, els camps de la factura i els registres financers s’afegeixen en segon pla després de la indexació i es poden tornar a calcular més endavant; apareixen a l’entrada quan estan llestos.
nullvol dir que no hi ha cap estat disponible (l’entrada es va indexar sense enriquiment en segon pla).external_idstring | nullID de l’entrada al sistema de l’integrador. És únic a l’organització entre les entrades que no provenen de fonts;
nullvol dir que no està definit./v1/cards-by-external-id/{external_id}llegeix i substitueix l’entrada a partir d’aquest ID.length ≤ 512
metadataMetadata