ReceivedDocument

Contains a request for an operation to be performed on a document, such as rotating, splitting, or text extraction.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
Direction
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies whether the org is receiving or sending the document.
Possible values are:
  • INCOMING—Incoming
  • OUTGOING—Outgoing
DocumentNumber
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Unique document identification number.
HasAutoOcrDisabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Determines whether text is extracted from the document automatically. Default is False.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the document is being processed.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the received document.
OcrStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Current state of the text extraction process.
Possible values are: Draft, Approved, In Approval, In Review, Obsolete, Superseded, Archived. Default is Draft.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The user who owns the ReceivedDocument record.
Priority
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Determines the order in which the document is processed when it is part of a queue.
Possible values are:
  • ONE—1
  • THREE—3
  • TWO—2
Source
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Origin of the incoming document. Can be used to specify processing priority.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Current stage of processing.
Possible values are:
  • APPROVED
  • ARCHIVED
  • COMPLETED
  • DRAFT
  • IN_REVIEW
  • NEEDS_REVIEW
  • OBSOLETE
  • PROCESSING
  • SUPERSEDED
StatusReason
Type
textarea
Properties
Create, Nillable, Update
Description
Reason for the status when processing and transforming the document.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ReceivedDocumentChangeEvent (API version 59.0)
Change events are available for the object.