Document.pages

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The pages of the document.

The documentCapture.documentToStructure(options) method supports documents up to five pages in length, so the returned documentCapture.Document object can contain up to five pages (as documentCapture.Page objects). When you submit an asynchronous extraction task using the N/task module, you can provide documents of any length, so the returned object contains as many pages as were in the provided document.

Type

documentCapture.Page[]

Supported Script Types

Server scripts

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

Module

N/documentCapture Module

Parent Object

documentCapture.Document

Sibling Object Members

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

const pages = extractedData.pages;

...
// Add additional code

General Notices