Send Estimate

POST 
/invoices/estimate/:estimateId/send

API to send estimate by estimate id

Request

Version stringrequired

API Version

Available optionsv3

estimateId stringrequired

Estimate Id

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
actionstringrequired
Available optionssms_and_emailsend_manuallyemailsms
liveModebooleanrequired

livemode for estimate

userIdstringrequired

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.

sentFromobject

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

estimateNamestring

estimate name

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "action": "sms_and_email",
  "liveMode": true,
  "userId": "6578278e879ad2646715ba9c",
  "sentFrom": {
    "fromName": "Alex",
    "fromEmail": "[email protected]"
  },
  "estimateName": "Estimate"
}

application/json

Created

application/json

Schema

Schema

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
_idstringrequired

Unique identifier

liveModebooleanrequired

Indicates if it is in live mode

deletedbooleanrequired

Indicates if deleted

namestringrequired

Name

currencystringrequired

Currency code

businessDetailsobjectrequired

Business details associated with the estimate

itemsarray[]required

An array of items

discountobjectrequired

Discount details for the estimate template

titlestring

Title

estimateNumberPrefixstring

Estimate number prefix

attachmentsobject[]

Attachments

updatedBystring

User Id of who last updated

totalnumberrequired

Total amount

createdAtstring<date-time>required

Timestamp when created

updatedAtstring<date-time>required

Timestamp when last updated

__vnumberrequired

Version number

automaticTaxesEnabledbooleanrequired

Indicates if automatic taxes are enabled for this estimate

termsNotesstring

Terms and conditions for the estimate, supports HTML markup

companyIdstringrequired

Company identifier associated with the estimate

contactDetailsobjectrequired

Contact details for the estimate

issueDatestring<date-time>required

Date when the estimate was issued

expiryDatestring<date-time>required

Date when the estimate expires

sentBystring

User who sent the estimate

automaticTaxesCalculatedbooleanrequired

Indicates if automatic taxes were calculated

metaobjectrequired

Additional metadata associated with the estimate

estimateActionHistorystring[]required

History of actions taken on the estimate

sentToobjectrequired

Recipient details for the estimate

frequencySettingsobjectrequired

Frequency settings for recurring estimates

lastVisitedAtstring<date-time>required

Timestamp when the estimate was last visited

totalamountInUSDnumberrequired

Total amount in USD

autoInvoiceobject

Auto-invoice settings for the estimate

traceIdstringrequired

Trace ID for logging and debugging

Example (auto)

{
  "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>",
  "companyId": "COMP12345",
  "contactDetails": {
    "id": "jvzfKTNdE7OYXXXXXX",
    "name": "Contact Name",
    "phoneNo": "+911111111114",
    "email": "[email protected]",
    "address": {
      "countryCode": "US"
    }
  },
  "issueDate": "2023-06-15T00:00:00.000Z",
  "expiryDate": "2023-07-15T00:00:00.000Z",
  "sentBy": "[email protected]",
  "automaticTaxesCalculated": true,
  "meta": {
    "key": "value"
  },
  "estimateActionHistory": [
    {
      "action": "Created",
      "timestamp": "2023-06-15T10:00:00.000Z"
    }
  ],
  "sentTo": {
    "email": [
      "[email protected]"
    ],
    "phoneNo": [
      "+1 99444444444"
    ]
  },
  "frequencySettings": {
    "enabled": false
  },
  "lastVisitedAt": "2023-06-20T08:30:00.000Z",
  "totalamountInUSD": 1500.75,
  "autoInvoice": {
    "enabled": true,
    "directPayments": false
  },
  "traceId": "010c7a01-857f-4619-970d-xyxyxyxy"
}