Send Invoice

Purpose

Email an invoice to the desired recipients.

Request URL

https://fsm.zoho.com/fsm/v1/Invoices/<record_id>/actions/send_invoice

record_id - The unique ID of the record.

Request Method

POST

Scope

scope=ZohoFSM.modules.custom.CREATE

Parameters

NameData TypeDescription
send_invoice_pdfBooleanWhether to add the invoice pdf as an attachment in the email
to_mail_ids*ArrayList of recipient email IDs
send_from_org_email_idBooleanWhether to send the email from the organization's email address

*Mandatory field

Sample Request:

Copiedcurl --request POST 'https://fsm.zoho.com/fsm/v1/Invoices/1004000000273113/actions/send_invoice' \
--header 'Authorization: Zoho-oauthtoken 1000.axxxxxxxxx.xxxxxxxxxx1' \
-d "@sendInvoice.json"

Sample Input

Copied{
    "data": {
        "send_invoice_pdf": true,
        "to_mail_ids": [
            "lucy.robins@zylker.com"
        ],
        "send_from_org_email_id": true
    }
}

Sample Response

Copied{
    "code": "SUCCESS",
    "details": {
        "code": 0,
        "is_first_email": false,
        "instrumentation": {
            "query_execution_time": 513,
            "response_write_time": 0,
            "page_context_write_time": 0,
            "request_handling_time": 3
        },
        "message": "Your invoice has been sent."
    },
    "message": "Your invoice has been sent.",
    "status": "success"
}

Sample Failure Response

Copied{
   "code": "ERROR",
   "details": {
       "code": 2,
       "message": "Invalid value passed for to_mail_ids"
   },
   "message": "Invalid value passed for to_mail_ids",
   "status": "error"
}