Create a Service Report

Purpose

To create a service report.

  • Create of Service Reports permission is required.
  • There are limits on the number of service reports that can be created in each edition.
  • The Standard Old template of the service report will not be supported.

Request URL

https://fsm.zoho.com/fsm/v1/Service_Reports

Request Method

POST

Scope

scope=ZohoFSM.modules.ServiceReports.CREATE

Input JSON Keys

NameDescriptionType
$technician_feedbackTo populate the Technician Feedback section of the service reportJSON Object
SummaryService Summary under Technician FeedbackString
Problem_StatementProblem Statement under Technician FeedbackString
   
$customer_feedbackTo populate the Customer Feedback section of the service reportJSON Object
Customer_FeedbackCustomer Feedback under Customer FeedbackString
Customer_RatingCustomer Rating under Customer FeedbackNumber
   

Appointment

(mandatory)

The ID of the service appointment for which you want to create the service report. You can obtain this ID from the List Service Appointments API.String
Template_Id

The ID of the PDF template that you want to use. You can obtain this from the record URL of the PDF template.

  1. Navigate to Setup > Customization > Templates > PDF Templates.
  2. Hover over the desired service report PDF template and click the Edit icon. The PDF template ID is the number at the end of the record URL.

If no value is specified, then the service report PDF template set as the default will be used.

String

Note:

  • Whether the JSON keys in $technician_feedback and $customer_feedback are mandatory depends on the properties you have set for these fields in the module builder (Setup > Customization > Module and Fields > Service Reports).
  • For custom fields, use the API Name obtained by clicking on the desired field at Setup > Customization > Module and Fields > Service Reports.

Sample Request

Copiedcurl --request POST 'https://fsm.zoho.com/fsm/v1/Service_Reports' \
--header 'Authorization: Zoho-oauthtoken 1000.26xxxxxxxxxx.xxxxxxxxxx0' \
--header 'content-type: application/json' \
--data "{"field1":"value1","field2":"value2"}"

Sample Input

Copied{
    "data": [
        {
            "$technician_feedback": {
                "Summary": "TV installed in the guest room",
                "Problem_Statement": "TV wall mounting"
            },
            "$customer_feedback": {
                "Customer_Feedback": "Good work !!!",
                "Customer_Rating": 3
            },
            "Appointment": "1003000002638061",
            "Template_Id": "795000001120001"
        }
    ]
}

Sample Response

Copied{
    "result": "success",
    "code": "SUCCESS",
    "data": {
        "Service_Reports": [
            {
                "UID": "Service_Reports_0",
                "Modified_Time": "2025-05-20T17:23:35+05:30",
                "Modified_By": {
                    "name": "Marianne Sheehan",
                    "id": "1003000000208001"
                },
                "Created_Time": "2025-05-20T17:23:35+05:30",
                "id": "1003000002644089",
                "Created_By": {
                    "name": "Marianne Sheehan",
                    "id": "1003000000208001"
                },
                "TabName": "ServiceReports"
            }
        ]
    },
    "status": "success"
}