Newer Version Available

This content describes an older version of this product. View Latest

DocumentRecipient

Connects a Service Report to a Digital Signature. This object is available in API version 55.0 and later.

Supported Calls

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

Fields

Field Details
DigitalSignatureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Digital Signature to be used on the Service Report.
This field is a relationship field.
Relationship Name
DigitalSignature
Relationship Type
Lookup
Refers To
DigitalSignature
DigitalSignatureUrl
Type
textarea
Properties
Create, Nillable, Update
Description
Link to request signature from Experience Cloud site.
DocumentId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The document sent to the recipient.
This field is a polymorphic relationship field.
Relationship Name
Document
Relationship Type
Lookup
Refers To
ServiceReport
DocumentRecipient
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Number automatically assigned to a new record.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
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, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the owner of this object. ID of the creator of this object.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
RecipientId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The recipient to sign the document.
This field is a polymorphic relationship field.
Relationship Name
Recipient
Relationship Type
Lookup
Refers To
Contact, User
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the document recipient record.
Possible values are:
  • Completed
  • Declined
  • Delivered
  • None
  • Sent
The default value is None.
StatusReason
Type
textarea
Properties
Create, Nillable, Update
Description
The final status reason.

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.

DocumentRecipientFeed
Feed tracking is available for the object.
DocumentRecipientOwnerSharingRule
Sharing rules are available for the object.
DocumentRecipientShare
Sharing is available for the object.