# Create Estimate Template

- **URL:** https://marketplace.gohighlevel.com/docs/ghl/invoices/create-estimate-template
- **Summary:** Create a new estimate template

[Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-estimate-template#__docusaurus_skipToContent_fallback)

Version: v3

Create Estimate Template
========================

POST 

https://services.leadconnectorhq.com/invoices/estimate/template

Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor

Create a new estimate template

### Requirements

#### Scope(s)

`invoices/estimate.write`

#### Auth Method(s)

`OAuth Access Token``Private Integration Token`

#### Token Type(s)

`Sub-Account Token``Agency Token`

Request[​](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-estimate-template#request "Direct link to request")

### Header Parameters

**Version** stringrequired

**Possible values:** \[`v3`\]

API Version

*   application/json

*   Body
*   Example (auto)

### Body**required**

**altId**stringrequired

Location Id or Agency Id

**Example:** `6578278e879ad2646715ba9c`

**altType**stringrequired

**Possible values:** \[`location`\]

**name**stringrequired

Estimate Name

**Example:** `Home Service Estimate Template`

**businessDetails** objectrequired

**logoUrl**string

Business Logo URL

**Example:** `https://example.com/logo.png`

**name**string

Business Name

**Example:** `ABC Corp.`

**phoneNo**string

Business Phone Number

**Example:** `+1-214-559-6993`

**address** object

Business Address

**addressLine1**string

Address Line 1

**Example:** `9931 Beechwood`

**addressLine2**string

Address Line 2

**Example:** `Beechwood`

**city**string

City

**Example:** `St. Houston`

**state**string

State

**Example:** `TX`

**countryCode**string

Country Code

**Example:** `US`

**postalCode**string

Postal Code

**Example:** `559-6993`

**website**string

Business Website Link

**Example:** `wwww.example.com`

**customValues**string\[\]

Custom Values

**currency**stringrequired

Currency code

**Example:** `USD`

**items**array\[\]required

An array of items for the estimate.

**liveMode**boolean

livemode for estimate

**Default value:** `true`

**Example:** `true`

**discount** objectrequired

**value**number

Discount Value

**Default value:** `0`

**Example:** `10`

**type**stringrequired

Discount type

**Possible values:** \[`percentage`, `fixed`\]

**Default value:** `percentage`

**Example:** `percentage`

**validOnProductIds**string\[\]

Product Ids on which discount is applicable

**Example:** `[ '6579751d56f60276e5bd4154' ]`

**termsNotes**string

Terms notes, Also supports HTML markups

**Example:** `<p>This is a default terms.</p>`

**title**string

Title for the estimate

**Example:** `ESTIMATE`

**automaticTaxesEnabled**boolean

Automatic taxes enabled for the Estimate

**Default value:** `false`

**Example:** `true`

**meta**object

Meta data for the estimate

**Example:** `{"key":"value"}`

**sendEstimateDetails** object

When sending estimate directly while saving

**altId**stringrequired

Location Id or Agency Id

**Example:** `6578278e879ad2646715ba9c`

**altType**stringrequired

**Possible values:** \[`location`\]

**action**stringrequired

**Possible values:** \[`sms_and_email`, `send_manually`, `email`, `sms`\]

**liveMode**booleanrequired

livemode for estimate

**Example:** `true`

**userId**stringrequired

Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.

**Example:** `6578278e879ad2646715ba9c`

**sentFrom** object

sender details for invoice, valid only if invoice is not sent manually

**fromName**string

Sender name to be used while sending email notification

**Example:** `Alex`

**fromEmail**string

Email id to be used while sending email notification

**Example:** `alex@example.com`

**estimateName**string

estimate name

**Example:** `Estimate`

**estimateNumberPrefix**string

Prefix for the estimate number

**Default value:** `EST-`

**Example:** `EST-`

**attachments** object\[\]

attachments for the invoice

*   Array \[\
    \
\
**id**stringrequired\
\
Id of the file selected\
\
**Example:** `6241712be68f7a98102ba272`\
\
**name**stringrequired\
\
Name of the file\
\
**Example:** `Electronics.pdf`\
\
**url**stringrequired\
\
URL of the file\
\
**Example:** `https://example.com/digital-delivery`\
\
**type**stringrequired\
\
Type of the file\
\
**size**numberrequired\
\
Size of the file\
\
**Example:** `10000`\
\
*   \]
    

**miscellaneousCharges** object

miscellaneous charges for the estimate

**charges**array\[\]required

charges for the processing fee

**collectedMiscellaneousCharges**number

collected miscellaneous charges

**Example:** `10`

**paidCharges** object\[\]

paid miscellaneous charges

*   Array \[\
    \
\
**name**stringrequired\
\
name of the processing fee\
\
**Example:** `Processing Fee`\
\
**charge**numberrequired\
\
charge for the processing fee\
\
**Example:** `10`\
\
**amount**numberrequired\
\
amount of the processing fee\
\
**Example:** `10`\
\
**_id**stringrequired\
\
id of the processing fee\
\
**Example:** `673d01d7d547648a8dab6211`\
\
*   \]
    

    {  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "name": "Home Service Estimate Template",  "businessDetails": {    "logoUrl": "https://example.com/logo.png",    "name": "ABC Corp.",    "phoneNo": "+1-214-559-6993",    "address": "9931 Beechwood, TX",    "website": "wwww.example.com",    "customValues": [      "string"    ]  },  "currency": "USD",  "items": [    null  ],  "liveMode": true,  "discount": {    "value": 10,    "type": "percentage",    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"  },  "termsNotes": "<p>This is a default terms.</p>",  "title": "ESTIMATE",  "automaticTaxesEnabled": true,  "meta": {    "key": "value"  },  "sendEstimateDetails": {    "altId": "6578278e879ad2646715ba9c",    "altType": "location",    "action": "sms_and_email",    "liveMode": true,    "userId": "6578278e879ad2646715ba9c",    "sentFrom": {      "fromName": "Alex",      "fromEmail": "alex@example.com"    },    "estimateName": "Estimate"  },  "estimateNumberPrefix": "EST-",  "attachments": [    {      "id": "6241712be68f7a98102ba272",      "name": "Electronics.pdf",      "url": "https://example.com/digital-delivery",      "type": "string",      "size": 10000    }  ],  "miscellaneousCharges": {    "charges": [      null    ],    "collectedMiscellaneousCharges": 10,    "paidCharges": [      {        "name": "Processing Fee",        "charge": 10,        "amount": 10,        "_id": "673d01d7d547648a8dab6211"      }    ]  }}

Responses[​](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-estimate-template#responses "Direct link to Responses")

*   201
*   400
*   401
*   422

Successfully created

*   application/json

*   Schema
*   Example (auto)

**Schema**

**altId**stringrequired

Location Id or Agency Id

**Example:** `6578278e879ad2646715ba9c`

**altType**stringrequired

**Possible values:** \[`location`\]

**_id**stringrequired

Unique identifier

**Example:** `67ac9a51106ee8311e911XXXX`

**liveMode**booleanrequired

Indicates if it is in live mode

**Example:** `true`

**deleted**booleanrequired

Indicates if deleted

**Example:** `false`

**name**stringrequired

Name

**Example:** `Estimate Name`

**currency**stringrequired

Currency code

**Example:** `USD`

**businessDetails**objectrequired

Business details associated with the estimate

**Example:** `{"logoUrl":"your_image-url","name":"Business name","address":{"addressLine1":"address line 1","city":"Test City","state":"State Name","countryCode":"US","postalCode":"12345"},"phoneNo":"+1 1234567890","website":"www.example.com","customValues":[{"name":"Test","fieldKey":"{{custom_values.test}}","id":"5DYTWoiQvWiIJZXX44XXX","value":"Test's Custom Value"}]}`

**items**array\[\]required

An array of items

**Example:** `[{"taxes":[],"taxInclusive":false,"_id":"67ac9a51106ee8311e911XXXX","description":"<p>Futuristic anti-gravity racing</p>","currency":"USD","productId":"67ac9a51106ee8311e911XXXX","priceId":"67ac9a51106ee8311e911XXXX","amount":9.99,"qty":1,"name":"TEST","type":"one_time"},{"taxes":[{"_id":"67ac9a51106ee8311e911XXXX","name":"TaxTwo","rate":8.5,"calculation":"exclusive"}],"taxInclusive":true,"_id":"67ac9a51106ee8311e911XXXX","productId":"67ac9a51106ee8311e911XXXX","priceId":"67ac9a51106ee8311e911XXXX","currency":"USD","name":"TEST2","qty":1,"amount":500,"description":"","type":"recurring"}]`

**discount** objectrequired

Discount details for the estimate template

**value**number

Discount Value

**Default value:** `0`

**Example:** `10`

**type**stringrequired

Discount type

**Possible values:** \[`percentage`, `fixed`\]

**Default value:** `percentage`

**Example:** `percentage`

**validOnProductIds**string\[\]

Product Ids on which discount is applicable

**Example:** `[ '6579751d56f60276e5bd4154' ]`

**title**string

Title

**Example:** `ESTIMATE`

**estimateNumberPrefix**string

Estimate number prefix

**Example:** `EST-`

**attachments** object\[\]

Attachments

*   Array \[\
    \
\
**id**stringrequired\
\
Id of the file selected\
\
**Example:** `6241712be68f7a98102ba272`\
\
**name**stringrequired\
\
Name of the file\
\
**Example:** `Electronics.pdf`\
\
**url**stringrequired\
\
URL of the file\
\
**Example:** `https://example.com/digital-delivery`\
\
**type**stringrequired\
\
Type of the file\
\
**size**numberrequired\
\
Size of the file\
\
**Example:** `10000`\
\
*   \]
    

**updatedBy**string

User Id of who last updated

**Example:** `3HIpOF9NIc5ltriQXXXX`

**total**numberrequired

Total amount

**Example:** `1222.03`

**createdAt**string<date-time>required

Timestamp when created

**Example:** `2025-02-12T13:17:47.416Z`

**updatedAt**string<date-time>required

Timestamp when last updated

**Example:** `2025-02-12T13:17:47.416Z`

**__v**numberrequired

Version number

**Example:** `0`

**automaticTaxesEnabled**booleanrequired

Indicates if automatic taxes are enabled for this estimate

**Example:** `false`

**termsNotes**string

Terms and conditions for the estimate, supports HTML markup

**Example:** `<p>All services are subject to availability.</p>`

    {  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "_id": "67ac9a51106ee8311e911XXXX",  "liveMode": true,  "deleted": false,  "name": "Estimate Name",  "currency": "USD",  "businessDetails": {    "logoUrl": "your_image-url",    "name": "Business name",    "address": {      "addressLine1": "address line 1",      "city": "Test City",      "state": "State Name",      "countryCode": "US",      "postalCode": "12345"    },    "phoneNo": "+1 1234567890",    "website": "www.example.com",    "customValues": [      {        "name": "Test",        "fieldKey": "{{custom_values.test}}",        "id": "5DYTWoiQvWiIJZXX44XXX",        "value": "Test's Custom Value"      }    ]  },  "items": [    {      "taxes": [],      "taxInclusive": false,      "_id": "67ac9a51106ee8311e911XXXX",      "description": "<p>Futuristic anti-gravity racing</p>",      "currency": "USD",      "productId": "67ac9a51106ee8311e911XXXX",      "priceId": "67ac9a51106ee8311e911XXXX",      "amount": 9.99,      "qty": 1,      "name": "TEST",      "type": "one_time"    },    {      "taxes": [        {          "_id": "67ac9a51106ee8311e911XXXX",          "name": "TaxTwo",          "rate": 8.5,          "calculation": "exclusive"        }      ],      "taxInclusive": true,      "_id": "67ac9a51106ee8311e911XXXX",      "productId": "67ac9a51106ee8311e911XXXX",      "priceId": "67ac9a51106ee8311e911XXXX",      "currency": "USD",      "name": "TEST2",      "qty": 1,      "amount": 500,      "description": "",      "type": "recurring"    }  ],  "discount": {    "type": "percentage",    "value": 0  },  "title": "ESTIMATE",  "estimateNumberPrefix": "EST-",  "attachments": [    {      "id": "6241712be68f7a98102ba272",      "name": "Electronics.pdf",      "url": "https://example.com/digital-delivery",      "type": "string",      "size": 10000    }  ],  "updatedBy": "3HIpOF9NIc5ltriQXXXX",  "total": 1222.03,  "createdAt": "2025-02-12T13:17:47.416Z",  "updatedAt": "2025-02-12T13:17:47.416Z",  "__v": 0,  "automaticTaxesEnabled": false,  "termsNotes": "<p>All services are subject to availability.</p>"}
> Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md).
**name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/invoices/invoice-api#authentication)
**type:** http**scopes:** `invoices/estimate.write`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

*   curl
*   nodejs
*   python
*   php
*   java
*   go
*   ruby
*   powershell

*   CURL

    curl -L 'https://services.leadconnectorhq.com/invoices/estimate/template' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \-H 'Authorization: Bearer <Authorization>' \--data-raw '{  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "name": "Home Service Estimate Template",  "businessDetails": {    "logoUrl": "https://example.com/logo.png",    "name": "ABC Corp.",    "phoneNo": "+1-214-559-6993",    "address": {      "addressLine1": "9931 Beechwood",      "addressLine2": "Beechwood",      "city": "St. Houston",      "state": "TX",      "countryCode": "US",      "postalCode": "559-6993"    },    "website": "wwww.example.com",    "customValues": [      "string"    ]  },  "currency": "USD",  "items": [    null  ],  "liveMode": true,  "discount": {    "value": 10,    "type": "percentage",    "validOnProductIds": "[ '\''6579751d56f60276e5bd4154'\'' ]"  },  "termsNotes": "<p>This is a default terms.</p>",  "title": "ESTIMATE",  "automaticTaxesEnabled": true,  "meta": {    "key": "value"  },  "sendEstimateDetails": {    "altId": "6578278e879ad2646715ba9c",    "altType": "location",    "action": "sms_and_email",    "liveMode": true,    "userId": "6578278e879ad2646715ba9c",    "sentFrom": {      "fromName": "Alex",      "fromEmail": "alex@example.com"    },    "estimateName": "Estimate"  },  "estimateNumberPrefix": "EST-",  "attachments": [    {      "id": "6241712be68f7a98102ba272",      "name": "Electronics.pdf",      "url": "https://example.com/digital-delivery",      "type": "string",      "size": 10000    }  ],  "miscellaneousCharges": {    "charges": [      null    ],    "collectedMiscellaneousCharges": 10,    "paidCharges": [      {        "name": "Processing Fee",        "charge": 10,        "amount": 10,        "_id": "673d01d7d547648a8dab6211"      }    ]  }}'

RequestCollapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Security SchemeLocation-AccessAgency-Access

Bearer Token

Parameters

Version — headerrequired\---v3

Body required

{
  "altId": "6578278e879ad2646715ba9c",  "altType": "location",  "name": "Home Service Estimate Template",  "businessDetails": {    "logoUrl": "https://example.com/logo.png",    "name": "ABC Corp.",    "phoneNo": "+1-214-559-6993",    "address": {      "addressLine1": "9931 Beechwood",      "addressLine2": "Beechwood",      "city": "St. Houston",      "state": "TX",      "countryCode": "US",      "postalCode": "559-6993"    },    "website": "wwww.example.com",    "customValues": \[      "string"    \]  },  "currency": "USD",  "items": \[    null  \],  "liveMode": true,  "discount": {    "value": 10,    "type": "percentage",    "validOnProductIds": "\[ '6579751d56f60276e5bd4154' \]"  },  "termsNotes": "<p>This is a default terms.</p>",  "title": "ESTIMATE",  "automaticTaxesEnabled": true,  "meta": {    "key": "value"  },  "sendEstimateDetails": {    "altId": "6578278e879ad2646715ba9c",    "altType": "location",    "action": "sms_and_email",    "liveMode": true,    "userId": "6578278e879ad2646715ba9c",    "sentFrom": {      "fromName": "Alex",      "fromEmail": "alex@example.com"    },    "estimateName": "Estimate"  },  "estimateNumberPrefix": "EST-",  "attachments": \[    {      "id": "6241712be68f7a98102ba272",      "name": "Electronics.pdf",      "url": "https://example.com/digital-delivery",      "type": "string",      "size": 10000    }  \],  "miscellaneousCharges": {    "charges": \[      null    \],    "collectedMiscellaneousCharges": 10,    "paidCharges": \[      {        "name": "Processing Fee",        "charge": 10,        "amount": 10,        "_id": "673d01d7d547648a8dab6211"      }    \]  }
}
Send API Request

ResponseClear

Click the `Send API Request` button above and see the response here!