Objetos
CardList
Campos
expandedCardExpandedpermissionsObjectPermissionListaccessstringValores permitidos:
wholepartialaccess_contactstringA quién dirigirse para obtener acceso (solo cuando
access=partial).aclobjectCampos
verifybooleanobligatoriowritebooleanobligatorio
categorystringobligatoriocategory_confidencenumber | nullobligatoriocategory_lockedbooleanobligatoriocategory_reviewbooleanobligatoriocollectionstringobligatoriocollection_idintegerobligatoriocollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullContenido del editor de la última versión publicada. El campo puede no aparecer; en ese caso, obtenga el contenido del editor a partir de un borrador (
POST /v1/draftsconcard_id).editing_lockEditingLock | nullBloqueo de edición activo. El campo puede no aparecer; en ese caso, el editor sabe quién tiene el bloqueo por la respuesta
409 cards.lockeddePOST /v1/cards/{card_id}/lock.created_atstring (date-time)obligatoriodays_since_verifiedintegerobligatorioerrorstring | nullobligatorioeventsarray of CardEventfeedback_negintegerobligatoriofeedback_posintegerobligatoriofoldersarray of CardFolderRefSolo en la lista de tarjetas: las carpetas que contienen la tarjeta (las que el usuario puede ver), con sus rutas desde la raíz de la colección. Una lista vacía significa que la tarjeta no está en ninguna carpeta.
has_tablesbooleanSolo en la lista de tarjetas.
hidden_partsbooleanidstringobligatoriojobJob | nullorg_idintegerobligatorioowner_activeboolean | nullowner_idinteger | nullobligatorioowner_namestring | nullobligatoriopagesinteger | nullobligatorioparserstring | nullobligatorioAnalizador del documento como código neutro:
document(estructura completa: páginas, títulos, tablas, páginas escaneadas),pdf(la capa de texto del PDF),docx,xlsx,csv,markdown,html,text. La lista puede ampliarse.sensitivebooleanobligatoriosha256string | nullobligatoriosizeintegerobligatoriosnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanobligatoriosource_pathstring | nullobligatoriosource_urlstring | nullobligatoriostatusstringobligatorioValores permitidos:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringobligatoriotitlestringobligatoriotrustnumberobligatoriotrust_if_verifiednumberupdated_atstring (date-time)obligatorioverified_atstring (date-time) | nullobligatorioverified_byinteger | nullobligatorioverified_by_namestring | nullverifier_idsarray of integerobligatorioverifiersarray of objectCampos
activebooleanobligatorioidintegerobligatorionamestringobligatorio
verify_interval_daysintegerobligatorioversionintegerobligatorioversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectConfiguración manual del análisis (vista previa).
doc_kindDocKind | nullTipo de documento.
nullsi el tipo no está determinado (por ejemplo, en las tarjetas indexadas antes de que existieran los tipos de documento).doc_kind_confidencenumber | nullGrado de certeza del tipo de documento, de 0 a 1.
doc_kind_sourcestring | nullQué determinó el tipo: reglas (
rules), un usuario (manual) o la clasificación automática. La lista puede ampliarse: trate un valor desconocido como clasificación automática.Valores permitidos:
rulesmanualnullinvoiceDocInvoiceExtraction | nullCampos de una factura, una nota de crédito o un recibo (solo para estos tipos, y solo en la tarjeta, no en la lista).
nullsi no tiene acceso a todo el documento, porque los campos se extraen del documento completo.warningsarray of ReviewWarningAdvertencias del análisis del documento (
ReviewWarning; solo en la tarjeta, no en la lista).enrichmentCardEnrichmentStatus | nullEstado del enriquecimiento (solo en la tarjeta, no en la lista). El tipo de documento, los campos de la factura y los registros financieros se añaden en segundo plano después de la indexación y pueden recalcularse más tarde; aparecen en la tarjeta cuando están listos.
nullsignifica que no hay estado disponible (la tarjeta se indexó sin enriquecimiento en segundo plano).external_idstring | nullID de la tarjeta en el sistema del integrador. Es único en la organización entre las tarjetas que no proceden de fuentes;
nullsignifica que no está definido./v1/cards-by-external-id/{external_id}lee y sustituye la tarjeta a partir de él.length ≤ 512
metadataMetadata