Create Estimate Template

Create a new estimate template

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

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Body

string

default:"6578278e879ad2646715ba9c"

required

Account Id or Agency Id

string

required

Posibles valores: ‘account’

string

default:"Home Service Estimate Template"

required

Estimate Name

object

required

Show propiedades

string

default:"https://example.com/logo.png"

Business Logo URL

string

default:"ABC Corp."

Business Name

string

default:"+1-214-559-6993"

Business Phone Number

object

default:"9931 Beechwood, TX"

Business Address

string

default:"wwww.example.com"

Business Website Link

string[]

Custom Values

string

default:"USD"

required

Currency code

array[]

required

An array of items for the estimate.

boolean

default:"True"

livemode for estimate

object

required

Show propiedades

number

default:"10"

Discount Value

string

default:"percentage"

required

Discount type Posibles valores: ‘percentage’, ‘fixed’

string[]

default:"[ '6579751d56f60276e5bd4154' ]"

Product Ids on which discount is applicable

string

default:"<p>This is a default terms.</p>"

Terms notes, Also supports HTML markups

string

default:"ESTIMATE"

Title for the estimate

boolean

default:"True"

Automatic taxes enabled for the Estimate

object

Meta data for the estimate

object

When sending estimate directly while saving

string

default:"EST-"

Prefix for the estimate number

object[]

attachments for the invoice

Show cada item

string

default:"6241712be68f7a98102ba272"

required

Id of the file selected

string

default:"Electronics.pdf"

required

Name of the file

string

default:"https://example.com/digital-delivery"

required

URL of the file

string

required

Type of the file

number

default:"10000"

required

Size of the file

object

miscellaneous charges for the estimate

Respuestas

201 - Successfully created

string

default:"6578278e879ad2646715ba9c"

required

Account Id or Agency Id

string

required

Posibles valores: ‘account’

string

default:"67ac9a51106ee8311e911XXXX"

required

Unique identifier

boolean

default:"True"

required

Indicates if it is in live mode

boolean

default:"False"

required

Indicates if deleted

string

default:"Estimate Name"

required

Name

string

default:"USD"

required

Currency code

object

required

Business details associated with the estimate

array[]

required

An array of items

object

required

Discount details for the estimate template

string

default:"ESTIMATE"

Title

string

default:"EST-"

Estimate number prefix

object[]

Attachments

Show cada item

string

default:"6241712be68f7a98102ba272"

required

Id of the file selected

string

default:"Electronics.pdf"

required

Name of the file

string

default:"https://example.com/digital-delivery"

required

URL of the file

string

required

Type of the file

number

default:"10000"

required

Size of the file

string

default:"3HIpOF9NIc5ltriQXXXX"

User Id of who last updated

number

default:"1222.03"

required

Total amount

string

default:"2025-02-12T13:17:47.416Z"

required

Timestamp when created

string

default:"2025-02-12T13:17:47.416Z"

required

Timestamp when last updated

number

default:"0"

required

Version number

boolean

default:"False"

required

Indicates if automatic taxes are enabled for this estimate

string

Terms and conditions for the estimate, supports HTML markup

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "_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,
  // truncado: 48 lineas mas
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate/template' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "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": [
    []
  ],
  "liveMode": true,
  "discount": {
    "value": 10,
    "type": "percentage",
    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
  },
  "termsNotes": "<p>This is a default terms.</p>",
  "title": "ESTIMATE",
  "automaticTaxesEnabled": true,
  "meta": {
    "key": "value"
  },
  "estimateNumberPrefix": "EST-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "string",
      "size": 10000
    }
  ]
}'

const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/template', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "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": [[]], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "<p>This is a default terms.</p>", "title": "ESTIMATE", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/invoices/estimate/template',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "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": [[]], "liveMode": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "<p>This is a default terms.</p>", "title": "ESTIMATE", "automaticTaxesEnabled": true, "meta": {"key": "value"}, "estimateNumberPrefix": "EST-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/estimate/template');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', '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': [[]], 'liveMode': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': '<p>This is a default terms.</p>', 'title': 'ESTIMATE', 'automaticTaxesEnabled': true, 'meta': {'key': 'value'}, 'estimateNumberPrefix': 'EST-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Create Estimate Template

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo