Salesforce Docs Portal

ReceivedDocument

Contains a request for an operation to be performed on a document, such as rotating, splitting, or text extraction. This object is available in API version 50.0 and later.

Supported Calls

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

Fields

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:
    • 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 for when the current user last viewed a record related to this record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed.

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:
    • 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:
    • APPROVED
    • ARCHIVED
    • COMPLETED—Document processing is complete.
    • DRAFT
    • IN_REVIEW
    • NEEDS_REVIEW—Document requires review, for example because processing couldn’t be completed.
    • OBSOLETE
    • PROCESSING—Document processing is in progress.
    • 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.