documentCapture.DocumentType

Note:

The content in this help topic pertains to SuiteScript 2.1.

Enum Description

Holds values for the document type.

Use this enum to specify the type of document you're providing when you call documentCapture.documentToStructure(options) (using the options.documentType parameter). By specifying the type of document, the service can apply pretrained models that are optimized for that type, which can provide more accurate extraction results.

Module

N/documentCapture Module

Supported Script Types

Server scripts

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

Since

2025.2

Values

Value
`BANK_STATEMENT`
`CHECK`
`DRIVER_LICENSE`
`HEALTH_INSURANCE_ID`
`INVOICE`
`OTHERS`
`PASSPORT`
`PAYSLIP`
`RECEIPT`
`RESUME`
`TAX_FORM`

Value

BANK_STATEMENT

CHECK

DRIVER_LICENSE

HEALTH_INSURANCE_ID

INVOICE

OTHERS

PASSPORT

PAYSLIP

RECEIPT

RESUME

TAX_FORM

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.TEXT_EXTRACTION,
        documentCapture.Feature.FIELD_EXTRACTION
    ]
});

...
// Add additional code

General Notices