Version: v3

Create New Estimate

POST /invoices/estimate

Create a new estimate with the provided details

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body
Example (auto)

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired

Available optionslocation

namestringrequired

Estimate Name

businessDetailsobjectrequired

currencystringrequired

Currency code

itemsobject[]required

An array of items for the estimate.

liveModeboolean

livemode for estimate

Default value: true

discountobjectrequired

termsNotesstring

Terms notes, Also supports HTML markups

titlestring

Title for the estimate

contactDetailsobjectrequired

Contact information to send the estimate to

estimateNumbernumber

Estimate Number, if not specified will take in the next valid estimate number

issueDatestring

issue date estimate

expiryDatestring

expiry date estimate

sentToobject

Email and sent to details for the estimate

automaticTaxesEnabledboolean

Automatic taxes enabled for the Estimate

Default value: false

metaobject

Meta data for the estimate

sendEstimateDetailsobject

When sending estimate directly while saving

frequencySettingsobjectrequired

frequency settings for the estimate

estimateNumberPrefixstring

Prefix for the estimate number

Default value: EST-

userIdstring

User Id

attachmentsobject[]

attachments for the invoice

autoInvoiceobject

Auto invoice for the estimate

miscellaneousChargesobject

miscellaneous charges for the estimate

paymentScheduleConfigobject

Payment Schedule Config for the estimate

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "Home Service Estimate",
  "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": [
    {
      "name": "ABC Product",
      "description": "ABC Corp.",
      "productId": "6578278e879ad2646715ba9c",
      "priceId": "6578278e879ad2646715ba9c",
      "currency": "USD",
      "amount": 999,
      "qty": 1,
      "taxes": [
        {
          "_id": "string",
          "name": "string",
          "rate": 0,
          "calculation": "exclusive",
          "description": "string",
          "taxId": "string"
        }
      ],
      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
      "isSetupFeeItem": true,
      "type": "one_time",
      "taxInclusive": true,
      "attachments": [
        "https://example.com/file1.jpg",
        "https://example.com/file2.png"
      ]
    }
  ],
  "liveMode": true,
  "discount": {
    "value": 10,
    "type": "percentage",
    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
  },
  "termsNotes": "<p>This is a default terms.</p>",
  "title": "ESTIMATE",
  "contactDetails": {
    "id": "6578278e879ad2646715ba9c",
    "name": "Alex",
    "phoneNo": "+1234567890",
    "email": "[email protected]",
    "additionalEmails": [
      {
        "email": "[email protected]"
      }
    ],
    "companyName": "ABC Corp.",
    "address": {
      "addressLine1": "9931 Beechwood",
      "addressLine2": "Beechwood",
      "city": "St. Houston",
      "state": "TX",
      "countryCode": "US",
      "postalCode": "559-6993"
    },
    "customFields": [
      "string"
    ]
  },
  "estimateNumber": 1001,
  "issueDate": "2024-08-07",
  "expiryDate": "2024-08-10",
  "sentTo": {
    "email": [
      "[email protected]"
    ],
    "emailCc": [
      "[email protected]"
    ],
    "emailBcc": [
      "[email protected]"
    ],
    "phoneNo": [
      "+1-214-559-6993"
    ]
  },
  "automaticTaxesEnabled": true,
  "meta": {
    "key": "value"
  },
  "sendEstimateDetails": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "action": "sms_and_email",
    "liveMode": true,
    "userId": "6578278e879ad2646715ba9c",
    "sentFrom": {
      "fromName": "Alex",
      "fromEmail": "[email protected]"
    },
    "estimateName": "Estimate"
  },
  "frequencySettings": {
    "enabled": true,
    "schedule": {
      "executeAt": "string",
      "rrule": {
        "intervalType": "monthly",
        "interval": 2,
        "startDate": "2023-01-01",
        "startTime": "20:45:00",
        "endDate": "2029-11-01",
        "endTime": "18:45:00",
        "dayOfMonth": 15,
        "dayOfWeek": "mo",
        "numOfWeek": -1,
        "monthOfYear": "jan",
        "count": 10,
        "daysBefore": 5,
        "useStartAsPrimaryUserAccepted": true,
        "endType": "by"
      }
    }
  },
  "estimateNumberPrefix": "EST-",
  "userId": "6578278e879ad2646715ba9c",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "string",
      "size": 10000
    }
  ],
  "autoInvoice": {
    "enabled": true,
    "directPayments": true
  },
  "miscellaneousCharges": {
    "charges": [
      null
    ],
    "collectedMiscellaneousCharges": 10,
    "paidCharges": [
      {
        "name": "Processing Fee",
        "charge": 10,
        "amount": 10,
        "_id": "673d01d7d547648a8dab6211"
      }
    ]
  },
  "paymentScheduleConfig": {
    "type": "fixed",
    "dateConfig": {
      "depositDateType": "estimate_accepted",
      "scheduleDateType": "regular_interval"
    },
    "schedules": [
      null
    ]
  }
}

application/json

Created

application/json

Schema
Example (auto)

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

{
  "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"
}

Create New Estimate

/invoices/estimate

Request​

Bodyrequired

Request