fax EntityType

Activity that tracks call outcome and number of pages for a fax and optionally stores an electronic copy of the document.

Entity Set Path
[organization URI]/api/data/v9.2/faxes
Base Type
activitypointer
Display Name
Fax
Primary Key
activityid
Primary Key Attribute
subject
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
activityadditionalparams Edm.String

Additional information provided by the external application as JSON. For internal use only.

Inherited From: activitypointer

activityid Edm.Guid

Unique identifier of the activity.

Display Name: Fax

Inherited From: activitypointer

activitytypecode Edm.String

Type of activity.

Display Name: Activity Type

Inherited From: activitypointer

Read Only
actualdurationminutes Edm.Int32

Actual duration of the activity in minutes.

Display Name: Duration

Inherited From: activitypointer

actualend Edm.DateTimeOffset

Actual end time of the activity.

Display Name: Actual End

Inherited From: activitypointer

actualstart Edm.DateTimeOffset

Actual start time of the activity.

Display Name: Actual Start

Inherited From: activitypointer

billingcode Edm.String

Type the billing code for the fax to make sure the fax is charged to the correct sender or customer account.

Display Name: Billing Code

Inherited From: activitypointer

category Edm.String

Type a category to identify the fax type, such as sales offer or press release, to tie the fax to a business group or function.

Display Name: Category

Inherited From: activitypointer

community Edm.Int32

Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only.

Inherited From: activitypointer

coverpagename Edm.String

Type the name of the cover page to use when sending the fax.

Display Name: Cover Page Name

Inherited From: activitypointer

createdon Edm.DateTimeOffset

Date and time when the activity was created.

Display Name: Created On

Inherited From: activitypointer

Read Only
deliverylastattemptedon Edm.DateTimeOffset

Date and time when the delivery of the activity was last attempted.

Inherited From: activitypointer

Read Only
deliveryprioritycode Edm.Int32

Priority of delivery of the activity to the email server.

Inherited From: activitypointer

description Edm.String

Description of the activity.

Display Name: Description

Inherited From: activitypointer

descriptionblobid Edm.Binary

File that contains description content.

Inherited From: activitypointer

Read Only
descriptionblobid_name Edm.String

Inherited From: activitypointer

Read Only
directioncode Edm.Boolean

Select the direction of the fax as incoming or outbound.

Display Name: Direction

Inherited From: activitypointer

Default Options
Values Label
1 Outgoing
0 Incoming
exchangeitemid Edm.String

The message id of activity which is returned from Exchange Server.

Inherited From: activitypointer

exchangerate Edm.Decimal

Exchange rate for the currency associated with the activitypointer with respect to the base currency.

Display Name: Exchange Rate

Inherited From: activitypointer

Read Only
exchangeweblink Edm.String

Shows the web link of Activity of type email.

Inherited From: activitypointer

faxnumber Edm.String

Type the recipient's fax number.

Display Name: Fax Number

Inherited From: activitypointer

formattedscheduledend Edm.DateTimeOffset

Formatted scheduled end time of the activity.

Inherited From: activitypointer

Read Only
formattedscheduledstart Edm.DateTimeOffset

Formatted scheduled start time of the activity.

Inherited From: activitypointer

Read Only
importsequencenumber Edm.Int32

Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

Inherited From: activitypointer

instancetypecode Edm.Int32

Type of instance of a recurring series.

Inherited From: activitypointer

Read Only
isbilled Edm.Boolean

Information regarding whether the activity was billed as part of resolving a case.

Display Name: Is Billed

Inherited From: activitypointer

Default Options
Values Label
1 Yes
0 No
ismapiprivate Edm.Boolean

For internal use only.

Inherited From: activitypointer

isregularactivity Edm.Boolean

Information regarding whether the activity is a regular activity type or event type.

Display Name: Is Regular Activity

Inherited From: activitypointer

Read Only
Default Options
Values Label
1 Yes
0 No
isworkflowcreated Edm.Boolean

Information regarding whether the activity was created from a workflow rule.

Display Name: Is Workflow Created

Inherited From: activitypointer

Default Options
Values Label
1 Yes
0 No
lastonholdtime Edm.DateTimeOffset

Contains the date and time stamp of the last on hold time.

Display Name: Last On Hold Time

Inherited From: activitypointer

leftvoicemail Edm.Boolean

Left the voice mail

Inherited From: activitypointer

modifiedon Edm.DateTimeOffset

Date and time when activity was last modified.

Display Name: Modified On

Inherited From: activitypointer

Read Only
numberofpages Edm.Int32

Type the number of pages included in the fax.

Display Name: Number of Pages

Inherited From: activitypointer

onholdtime Edm.Int32

Shows how long, in minutes, that the record was on hold.

Display Name: On Hold Time (Minutes)

Inherited From: activitypointer

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

Inherited From: activitypointer

postponeactivityprocessinguntil Edm.DateTimeOffset

For internal use only.

Inherited From: activitypointer

Read Only
prioritycode Edm.Int32

Priority of the activity.

Display Name: Priority

Inherited From: activitypointer

Default Options
Values Label
0 Low
1 Normal
2 High
processid Edm.Guid

Unique identifier of the Process.

Display Name: Process

Inherited From: activitypointer

scheduleddurationminutes Edm.Int32

Scheduled duration of the activity, specified in minutes.

Display Name: Scheduled Duration

Inherited From: activitypointer

scheduledend Edm.DateTimeOffset

Scheduled end time of the activity.

Display Name: Due Date

Inherited From: activitypointer

scheduledstart Edm.DateTimeOffset

Scheduled start time of the activity.

Display Name: Start Date

Inherited From: activitypointer

senton Edm.DateTimeOffset

Date and time when the activity was sent.

Inherited From: activitypointer

Read Only
seriesid Edm.Guid

Uniqueidentifier specifying the id of recurring series of an instance.

Inherited From: activitypointer

Read Only
sortdate Edm.DateTimeOffset

Shows the date and time by which the activities are sorted.

Display Name: Sort Date

Inherited From: activitypointer

stageid Edm.Guid

Unique identifier of the Stage.

Display Name: (Deprecated) Process Stage

Inherited From: activitypointer

statecode Edm.Int32

Status of the activity.

Display Name: Activity Status

Inherited From: activitypointer

Default Options
Values Label
0 Open
1 Completed
2 Canceled
statuscode Edm.Int32

Reason for the status of the activity.

Display Name: Status Reason

Inherited From: activitypointer

Default Options
Values Label
1 Open
2 Completed
3 Sent
4 Received
5 Canceled
subcategory Edm.String

Type a subcategory to identify the fax type to relate the activity to a specific product, sales region, business group, or other function.

Display Name: Sub-Category

Inherited From: activitypointer

subject Edm.String

Subject associated with the activity.

Display Name: Subject

Inherited From: activitypointer

subscriptionid Edm.Guid

For internal use only.

Display Name: Subscription

Inherited From: activitypointer

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

Inherited From: activitypointer

traversedpath Edm.String

For internal use only.

Display Name: (Deprecated) Traversed Path

Inherited From: activitypointer

tsid Edm.String

Type the Transmitting Subscriber ID (TSID) associated with a send action. This is typically a combination of the recipient's fax or phone number and company name.

Display Name: Transmit. Station Id

Inherited From: activitypointer

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

Inherited From: activitypointer

versionnumber Edm.Int64

Version number of the activity.

Display Name: Version Number

Inherited From: activitypointer

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the activity.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the activitypointer.

_modifiedby_value modifiedby

Unique identifier of user who last modified the activity.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the activitypointer.

_ownerid_value ownerid

Unique identifier of the user or team who owns the activity.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the activity.

_owningteam_value owningteam

Unique identifier of the team that owns the activity.

_owninguser_value owninguser

Unique identifier of the user that owns the activity.

_regardingobjectid_value regardingobjectid_account
regardingobjectid_adx_invitation
regardingobjectid_contact
regardingobjectid_knowledgearticle
regardingobjectid_knowledgebaserecord
regardingobjectid_mspp_adplacement
regardingobjectid_mspp_pollplacement
regardingobjectid_mspp_publishingstatetransitionrule
regardingobjectid_mspp_redirect
regardingobjectid_mspp_shortcut
regardingobjectid_mspp_website
regardingobjectid_new_interactionforemail

Unique identifier of the object with which the activity is associated.

_sendermailboxid_value sendermailboxid

Unique identifier of the mailbox associated with the sender of the email message.

_slaid_value sla_activitypointer_sla

Choose the service level agreement (SLA) that you want to apply to the case record.

_slainvokedid_value slainvokedid_activitypointer_sla

Last SLA that was applied to this case. This field is for internal use only.

_transactioncurrencyid_value transactioncurrencyid

Unique identifier of the currency associated with the activitypointer.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
activityid_activitypointer activitypointer activity_pointer_fax
createdby systemuser lk_activitypointer_createdby
createdby_fax systemuser lk_fax_createdby
createdonbehalfby systemuser lk_activitypointer_createdonbehalfby
createdonbehalfby_fax systemuser lk_fax_createdonbehalfby
modifiedby systemuser lk_activitypointer_modifiedby
modifiedby_fax systemuser lk_fax_modifiedby
modifiedonbehalfby systemuser lk_activitypointer_modifiedonbehalfby
modifiedonbehalfby_fax systemuser lk_fax_modifiedonbehalfby
ownerid principal owner_activitypointers
ownerid_fax principal owner_faxes
owningbusinessunit businessunit business_unit_activitypointer
owningbusinessunit_fax businessunit business_unit_fax_activities
owningteam team team_activity
owningteam_fax team team_fax
owninguser systemuser user_activity
owninguser_fax systemuser user_fax
regardingobjectid_account account Account_ActivityPointers
regardingobjectid_account_fax account Account_Faxes
regardingobjectid_adx_invitation adx_invitation adx_invitation_ActivityPointers
regardingobjectid_adx_invitation_fax adx_invitation adx_invitation_Faxes
regardingobjectid_contact contact Contact_ActivityPointers
regardingobjectid_contact_fax contact Contact_Faxes
regardingobjectid_knowledgearticle knowledgearticle KnowledgeArticle_ActivityPointers
regardingobjectid_knowledgearticle_fax knowledgearticle KnowledgeArticle_Faxes
regardingobjectid_knowledgebaserecord knowledgebaserecord KnowledgeBaseRecord_ActivityPointers
regardingobjectid_knowledgebaserecord_fax knowledgebaserecord KnowledgeBaseRecord_Faxes
regardingobjectid_mspp_adplacement mspp_adplacement mspp_adplacement_ActivityPointers
regardingobjectid_mspp_adplacement_fax mspp_adplacement mspp_adplacement_Faxes
regardingobjectid_mspp_pollplacement mspp_pollplacement mspp_pollplacement_ActivityPointers
regardingobjectid_mspp_pollplacement_fax mspp_pollplacement mspp_pollplacement_Faxes
regardingobjectid_mspp_publishingstatetransitionrule mspp_publishingstatetransitionrule mspp_publishingstatetransitionrule_ActivityPointers
regardingobjectid_mspp_publishingstatetransitionrule_fax mspp_publishingstatetransitionrule mspp_publishingstatetransitionrule_Faxes
regardingobjectid_mspp_redirect mspp_redirect mspp_redirect_ActivityPointers
regardingobjectid_mspp_redirect_fax mspp_redirect mspp_redirect_Faxes
regardingobjectid_mspp_shortcut mspp_shortcut mspp_shortcut_ActivityPointers
regardingobjectid_mspp_shortcut_fax mspp_shortcut mspp_shortcut_Faxes
regardingobjectid_mspp_website mspp_website mspp_website_ActivityPointers
regardingobjectid_mspp_website_fax mspp_website mspp_website_Faxes
regardingobjectid_new_interactionforemail interactionforemail new_interactionforemail_ActivityPointers
sendermailboxid mailbox activitypointer_sendermailboxid_mailbox
sla_activitypointer_sla sla manualsla_activitypointer
sla_fax_sla sla manualsla_fax
slainvokedid_activitypointer_sla sla sla_activitypointer
slainvokedid_fax_sla sla sla_fax
stageid_processstage processstage processstage_faxes
transactioncurrencyid transactioncurrency TransactionCurrency_ActivityPointer
transactioncurrencyid_fax transactioncurrency TransactionCurrency_Fax

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
activity_pointer_activity_mime_attachment activitymimeattachment objectid_activitypointer
activity_pointer_adx_inviteredemption adx_inviteredemption activityid_adx_inviteredemption
activity_pointer_adx_portalcomment adx_portalcomment activityid_adx_portalcomment
activity_pointer_appointment appointment activityid_activitypointer
activity_pointer_chat chat activityid_chat
activity_pointer_email email activityid_activitypointer
activity_pointer_fax fax activityid_activitypointer
activity_pointer_letter letter activityid_activitypointer
activity_pointer_phonecall phonecall activityid_activitypointer
activity_pointer_recurrencerule recurrencerule objectid
activity_pointer_recurringappointmentmaster recurringappointmentmaster activityid_activitypointer
activity_pointer_socialactivity socialactivity activityid_activitypointer
activity_pointer_task task activityid_activitypointer
activitypointer_activity_parties activityparty activityid_activitypointer
ActivityPointer_AsyncOperations asyncoperation regardingobjectid_activitypointer
ActivityPointer_BulkDeleteFailures bulkdeletefailure regardingobjectid_activitypointer
activitypointer_connections1 connection record1id_activitypointer
activitypointer_connections2 connection record2id_activitypointer
activitypointer_FileAttachments fileattachment objectid_activitypointer
ActivityPointer_QueueItem queueitem objectid_activitypointer
fax_actioncard actioncard regardingobjectid_fax_actioncard
fax_activity_parties activityparty activityid_fax
Fax_Annotation annotation objectid_fax
Fax_AsyncOperations asyncoperation regardingobjectid_fax
Fax_BulkDeleteFailures bulkdeletefailure regardingobjectid_fax
fax_connections1 connection record1id_fax
fax_connections2 connection record2id_fax
Fax_DuplicateBaseRecord duplicaterecord baserecordid_fax
Fax_DuplicateMatchingRecord duplicaterecord duplicaterecordid_fax
fax_principalobjectattributeaccess principalobjectattributeaccess objectid_fax
Fax_ProcessSessions processsession regardingobjectid_fax
Fax_QueueItem queueitem objectid_fax
Fax_SyncErrors syncerror regardingobjectid_fax_syncerror
slakpiinstance_activitypointer slakpiinstance regarding_activitypointer
slakpiinstance_fax slakpiinstance regarding_fax

Operations

The following operations can be used with the fax entity type.

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
SendEmail Not Bound
SendFax Not Bound
SendTemplate Not Bound

See also