Send Estimate

API to send estimate by estimate id

POST https://services.leadconnectorhq.com/invoices/estimate/{estimateId}/send

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.

Path parameters

string

default:"5f9d6d8b1b2d2c001f2d9e4b"

required

Estimate Id

Body

string

default:"6578278e879ad2646715ba9c"

required

Account Id or Agency Id

string

required

Posibles valores: ‘account’

string

required

Posibles valores: ‘sms_and_email’, ‘send_manually’, ‘email’, ‘sms’

boolean

default:"True"

required

livemode for estimate

string

default:"6578278e879ad2646715ba9c"

required

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

object

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

string

default:"Estimate"

estimate name

Respuestas

201 - 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

string

default:"COMP12345"

required

Company identifier associated with the estimate

object

required

Contact details for the estimate

string

default:"2023-06-15T00:00:00.000Z"

required

Date when the estimate was issued

string

default:"2023-07-15T00:00:00.000Z"

required

Date when the estimate expires

string

default:"user@example.com"

User who sent the estimate

boolean

default:"True"

required

Indicates if automatic taxes were calculated

object

required

Additional metadata associated with the estimate

string[]

required

History of actions taken on the estimate

object

required

Recipient details for the estimate

object

required

Frequency settings for recurring estimates

string

default:"2023-06-20T08:30:00.000Z"

required

Timestamp when the estimate was last visited

number

default:"1500.75"

required

Total amount in USD

object

Auto-invoice settings for the estimate

string

default:"010c7a01-857f-4619-970d-xyxyxyxy"

required

Trace ID for logging and debugging

{
  "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: 86 lineas mas
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "action": "sms_and_email",
  "liveMode": true,
  "userId": "6578278e879ad2646715ba9c",
  "estimateName": "Estimate"
}'

const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "action": "sms_and_email", "liveMode": true, "userId": "6578278e879ad2646715ba9c", "estimateName": "Estimate"}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "action": "sms_and_email", "liveMode": true, "userId": "6578278e879ad2646715ba9c", "estimateName": "Estimate"},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/estimate/YOUR_estimateId/send');
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', 'action': 'sms_and_email', 'liveMode': true, 'userId': '6578278e879ad2646715ba9c', 'estimateName': 'Estimate'}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Path parameters

Body

Respuestas

Ejemplo

​Autorización

​Path parameters

​Body

​Respuestas

​Ejemplo

Autorización

Path parameters

Body

Respuestas

Ejemplo