Field.type

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The type of the field.

This property can have values from the documentCapture.FieldType enum. The field type describes the type or category of data extracted for a specific field. It adds semantic meaning to the extracted information, which can help you understand and process the information more effectively.

Type

string

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/documentCapture Module

Parent Object

documentCapture.Field

Sibling Object Members

Field Object Members

Since

2025.2

Errors

Error Code	Thrown If
`READ_ONLY`	You try to set the value of this property.

Error Code

Thrown If

READ_ONLY

You try to set the value of this property.

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