documentCapture.Page

Note:

The content in this help topic pertains to SuiteScript 2.1.

Object Description

An extracted page from a document.

This object includes properties for the fields (Page.fields), lines (Page.lines), tables (Page.tables), and words (Page.words) of the page. These properties have values only when the associated feature is specified when you call documentCapture.documentToStructure(options). For example, the Page.fields property includes extracted fields only if the documentCapture.Feature.FIELD_EXTRACTION feature is specified. If you don't specify any features when you call this method, the TEXT_EXTRACTION and TABLE_EXTRACTION features are used by default.

Supported Script Types

Server scripts

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

Module

N/documentCapture Module

Methods and Properties

Page Object Members

Since

2025.2

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
});

const page = extractedData.pages[0];

...
// Add additional code

Syntax

Related Topics