Skip to main content
Get a preview of an estimate template
GET https://services.leadconnectorhq.com/invoices/estimate/template/preview

Autorización

Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
Version
string
default:"2021-07-28"
required
Versión de la API.

Query parameters

altId
string
default:"6578278e879ad2646715ba9c"
required
Account Id or Agency Id
altType
string
required
templateId
string
default:"5f9d6d8b1b2d2c001f2d9e4b"
required
Template Id

Respuestas

altId
string
default:"6578278e879ad2646715ba9c"
required
Account Id or Agency Id
altType
string
required
Posibles valores: ‘account’
_id
string
default:"67ac9a51106ee8311e911XXXX"
required
Unique identifier
liveMode
boolean
default:"True"
required
Indicates if it is in live mode
deleted
boolean
default:"False"
required
Indicates if deleted
name
string
default:"Estimate Name"
required
Name
currency
string
default:"USD"
required
Currency code
businessDetails
object
required
Business details associated with the estimate
items
array[]
required
An array of items
discount
object
required
Discount details for the estimate template
title
string
default:"ESTIMATE"
Title
estimateNumberPrefix
string
default:"EST-"
Estimate number prefix
attachments
object[]
Attachments
updatedBy
string
default:"3HIpOF9NIc5ltriQXXXX"
User Id of who last updated
total
number
default:"1222.03"
required
Total amount
createdAt
string
default:"2025-02-12T13:17:47.416Z"
required
Timestamp when created
updatedAt
string
default:"2025-02-12T13:17:47.416Z"
required
Timestamp when last updated
__v
number
default:"0"
required
Version number
automaticTaxesEnabled
boolean
default:"False"
required
Indicates if automatic taxes are enabled for this estimate
termsNotes
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
}
{}
{}
{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/invoices/estimate/template/preview' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/template/preview', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();
import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/invoices/estimate/template/preview',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/estimate/template/preview');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);