Class DocumentTypeChargeStatus

Represents a document type alongside additional information that is supported by the TrustID Cloud.

var api = new TVS.Api();
api.login('username', 'password').then(function() {
    // get list of document types that are supported...
    return api.getDocumentTypeChargeStatuses();
}).then(function(documentTypes) {
    // list of document types that are available:
    console.log('document types:', documentTypes);

    // grouped list of document type options:
    console.log('grouped options:',
        DocumentTypeChargeStatus.getGroupedChoices(
            documentTypes,
            api.Config.getDocumentTypeSections()
        )
    );
});

See also

Api.getDocumentTypeChargeStatuses for more information about how to access a list of supported document types.

class DocumentTypeChargeStatus()

Represents a supported document type alongside some additional information.

Constant Properties

DocumentTypeChargeStatus.Id

The internal unique reference identifier of the document type record.

DocumentTypeChargeStatus.DocumentTypeCode

The document type code identifier that identifies a certain document type (typically based on its encoding used within the machine-readable zone).

DocumentTypeChargeStatus.DocumentType

The internal numeric document type identifier that identifies the document type when creating new documents for example.

DocumentTypeChargeStatus.Active

Determines if the document type is supported or not.

DocumentTypeChargeStatus.DisplayName

Represents the display name of the document type.

DocumentTypeChargeStatus.ChargeStatus

Identifies if the scanning and processing of a document type of this type are charged additionally.

DocumentTypeChargeStatus.DropDownSectionIndex

Represents the index position within the list of document type section names.

See Config.getDocumentTypeSections() for more information about document type section names.

DocumentTypeChargeStatus.AddedBy

Information about the origins of this document type.

Method

DocumentTypeChargeStatus.getGroupedChoices(documentTypes, sections)

Create a list of grouped options that represents all document types from the given list of document types but grouped into sections based on the given list of document type sections. Each option is sorted alphabetically within each section.

param object documentTypes:

List of document types received using Api.getDocumentTypeChargeStatuses.

param object sections:

List of document type sections obtained using Config.getDocumentTypeSections().