Invoice APIs

The built-in integration with Zoho Books/Invoice allows you to conveniently and quickly create invoices for your work orders.

List Invoices

Purpose

To fetch the list of all available invoices. The records fetched will be sorted by Created Time in descending order (recent ones first).

Request URL

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

Request Method

GET

Scope

scope=ZohoFSM.modules.custom.READ

Query Parameters

Parameter NameData TypeDescriptionPossible Values
page (optional)IntegerThe page from which you want to fetch the records. The default value is 1.Positive Integer values only
per_page (optional)IntegerThe number of records you want to fetch in a page. The default value is 200.Positive Integer values only

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Invoices' \
--header 'Authorization: Zoho-oauthtoken 1000.3xxxxxxxxx.xxxxxxxxxxxxx0e'

Sample Response

Copied{
    "data": [
        {
            "Status": "Draft",
            "Owner": {
                "name": "Lucy Robins",
                "id": "1439000000161001",
                "email": "lucy.robins@zylker.com"
            },
            "Modified_Time": "2022-09-13T06:42:36-07:00",
            "$currency_symbol": "$",
            "Created_Time": "2022-09-13T06:42:36-07:00",
            "$editable": true,
            "ZBilling_InvoiceId": "3219741000000147003",
            "Work_Order": {
                "name": "WO35",
                "id": "1439000000278142"
            },
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Name": "INV-000028",
            "Modified_By": {
                "name": "Lucy Robins",
                "id": "1439000000161001",
                "email": "lucy.robins@zylker.com"
            },
            "Exchange_Rate": 1,
            "Currency": "USD",
            "$inactive": false,
            "id": "1439000000282394",
            "Created_By": {
                "name": "Lucy Robins",
                "id": "1439000000161001",
                "email": "lucy.robins@zylker.com"
            }
        },
        {
            "Status": "Draft",
            "Owner": {
                "name": "Lucy Robins",
                "id": "1439000000161001",
                "email": "lucy.robins@zylker.com"
            },
            "Modified_Time": "2022-09-13T00:15:53-07:00",
            "$currency_symbol": "$",
            "Created_Time": "2022-09-13T00:15:53-07:00",
            "$editable": true,
            "ZBilling_InvoiceId": "3219741000000142005",
            "Work_Order": {
                "name": "WO35",
                "id": "1439000000278142"
            },
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Name": "INV-000027",
            "Modified_By": {
                "name": "Lucy Robins",
                "id": "1439000000161001",
                "email": "lucy.robins@zylker.com"
            },
            "Exchange_Rate": 1,
            "Currency": "USD",
            "$inactive": false,
            "id": "1439000000282334",
            "Created_By": {
                "name": "Lucy Robins",
                "id": "1439000000161001",
                "email": "lucy.robins@zylker.com"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}