documentCapture.FieldType

Note:

The content in this help topic pertains to SuiteScript 2.1.

Enum Description	Holds values for the type of a field. These enum values are returned as part of a documentCapture.Field object (in the Field.type property). They describe the category or type of data extracted for a specific field, providing semantic meaning and helping with structured processing of the data. documentCapture.Field objects are included in extracted content from a document only when the documentCapture.Feature.FIELD_EXTRACTION feature is specified when you call documentCapture.documentToStructure(options).
Module	N/documentCapture Module
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Since	2025.2

Values

Value
KEY_VALUE
LINE_ITEM
LINE_ITEM_FIELD
LINE_ITEM_GROUP
UNKNOWN

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/documentCapture Module Script Samples.

            // Add additional code
...

const extractedData = documentCapture.documentToStructure({
    file: file.load("SuiteScripts/sample_invoice.pdf"),
    documentType: documentCapture.DocumentType.INVOICE,
    features: [documentCapture.Feature.FIELD_EXTRACTION]
});

const fieldType = extractedData.pages[0].fields[0].type;

...
// Add additional code 

          

General Notices