--- schema_version: "1" id: 113f5b2a9f2b5aa6a0e3a4e19670890eedca8ac4b89c4d860c7490c4c296f33f title: ServiceReport collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_servicereport.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_servicereport.htm source_site: developer.salesforce.com content_type: documentation content_hash: 5c42fe2cacf92ddd802872886d68235d38fdd27571ea6c4ab434411aabf137e7 description: Represents a report that summarizes a work order, work order line item, or service appointment. --- # ServiceReport Represents a report that summarizes a work order, work order line item, or service appointment. The fields that appear on a service report are determined by its service report template. Service reports can be signed by the customer and shared as a PDF. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()update( ) ## Special Access Rules Field Service must be enabled. ## Fields | Field Name | Details | | --- | --- | | ContentVersionDocumentId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the service report version, used for storage. | | DocumentBody | Type base64 Properties Create, Nillable Description The report output. DocumentBody can’t be retrieved via REST API. | | DocumentContentType | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of data used for the report output.. Possible values are: - audio/ogg - text/calendar - video/3gpp2 - video/3gpp - image/avif - text/calendar - audio/x-caf - image/webp | | DocumentLength | Type int Properties Filter, Group, Nillable, Sort Description The length of the report output. | | DocumentName | Type string Properties Create, Filter, Group, Nillable, Sort Description The name of the report output, always set to Service Report. | | DocumentTemplate | Type string Properties Create, Filter, Group, Nillable, Sort Description The template used to generate service documents for the Document Builder feature. ![Important](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_important.png) #### Important DocumentTemplate is different from Template. The document template needs to reference a flexipage that is of type serviceDocument and must target the object used to generate the service document. For example, you can't use an Account flexipage for a service report tied to a work order. | | IsSigned | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the service report contains one or more signatures. This field isn’t supported for Document Builder. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note_tip.png) #### Tip Add this field to the Service Reports related list on work orders, work order line items, and service appointments. | | ParentId | Type reference Properties Create, Filter, Group, Sort Description The ID of the service appointment, work order, or work order line item that the service report summarizes. For example, if you click **Create Service Report** on a service appointment, this field lists the service appointment’s record ID. | | ServiceReportLanguage | Type picklist Properties Create, Filter, Group, Nillable, Sort, Restricted picklist Description The language used for the service report. The language is selected in the ServiceReportLanguage field on the associated work order. If the work order doesn’t specify a service report language, the report is translated in the default language in Salesforce of the person generating the report. | | ServiceReportNumber | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the service report. | | Status | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The status of the service report. Available in API version 53.0 and later. Possible values are: - Completed - Failed - Generating - In Progress - None - Queued The default value is None. | | Template | Type string Properties Create, Filter, Group, Nillable, Sort Description The service report template used to generate the service report. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### Note If the person creating the service report doesn’t have access to certain objects or fields that are included in the service report template, those fields aren’t visible in the report they create. | ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ServiceReportChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. Available in API version 55.0 and later. [ServiceReportHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object.