Create a new estimate with the provided details

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

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Body

NameTypeRequiredExampleDescription
altIdstringYes6578278e879ad2646715ba9cAccount Id or Agency Id
altTypestringYesPossible values: 'account'
namestringYesHome Service EstimateEstimate Name
  • businessDetails (object, required)

    • logoUrl (string): Business Logo URL Example: https://example.com/logo.png

    • name (string): Business Name Example: ABC Corp.

    • phoneNo (string): Business Phone Number Example: +1-214-559-6993

    • address (object): Business Address Example: 9931 Beechwood, TX

    • website (string): Business Website Link Example: wwww.example.com

    • customValues (string[]): Custom Values

NameTypeRequiredExampleDescription
currencystringYesUSDCurrency code
  • items (object[], required): An array of items for the estimate.

    • name (string, required): Invoice Item Name Example: ABC Product

    • description (string): Invoice descriptions Example: ABC Corp.

    • productId (string): Product Id Example: 6578278e879ad2646715ba9c

    • priceId (string): Price Id Example: 6578278e879ad2646715ba9c

    • currency (string, required): Currency Example: USD

    • amount (number, required): Product amount Example: 999

    • qty (number, required): Product Quantity Example: 1

    • taxes (object[]): Tax

      • _id (string, required)

      • name (string, required)

      • rate (number, required)

      • calculation (string): Possible values: 'exclusive'

      • description (string)

      • taxId (string)

    • automaticTaxCategoryId (string): Tax category id for calculating automatic tax Example: 6578278e879ad2646715ba9c

    • isSetupFeeItem (boolean): Setupfee item, only created when 1st invoice of recurring schedule is generated

    • type (string): Price type of the item Possible values: 'one_time', 'recurring' Example: one_time

    • taxInclusive (boolean): true if item amount is tax inclusive Example: True

    • attachments (string[]): Attachments for the line item

NameTypeRequiredExampleDescription
liveModebooleanNoTruelivemode for estimate
  • discount (object, required)

    • value (number): Discount Value Example: 10

    • type (string, required): Discount type Possible values: 'percentage', 'fixed' Example: percentage

    • validOnProductIds (string[]): Product Ids on which discount is applicable Example: [ '6579751d56f60276e5bd4154' ]

NameTypeRequiredExampleDescription
termsNotesstringNo<p>This is a default terms.</p>Terms notes, Also supports HTML markups
titlestringNoESTIMATETitle for the estimate
contactDetailsobjectYesContact information to send the estimate to
estimateNumbernumberNo1001Estimate Number, if not specified will take in the next valid estimate number
issueDatestringNo2024-08-07issue date estimate
expiryDatestringNo2024-08-10expiry date estimate
sentToobjectNoEmail and sent to details for the estimate
automaticTaxesEnabledbooleanNoTrueAutomatic taxes enabled for the Estimate
metaobjectNoMeta data for the estimate
sendEstimateDetailsobjectNoWhen sending estimate directly while saving
frequencySettingsobjectYesfrequency settings for the estimate
estimateNumberPrefixstringNoEST-Prefix for the estimate number
userIdstringNo6578278e879ad2646715ba9cUser Id
  • attachments (object[]): attachments for the invoice

    • id (string, required): Id of the file selected Example: 6241712be68f7a98102ba272

    • name (string, required): Name of the file Example: Electronics.pdf

    • url (string, required): URL of the file Example: https://example.com/digital-delivery

    • type (string, required): Type of the file

    • size (number, required): Size of the file Example: 10000

NameTypeRequiredExampleDescription
autoInvoiceobjectNoAuto invoice for the estimate
miscellaneousChargesobjectNomiscellaneous charges for the estimate
paymentScheduleConfigobjectNoPayment Schedule Config for the estimate

Responses

201 - Created
  • altId (string, required): Account Id or Agency Id Example: 6578278e879ad2646715ba9c

  • altType (string, required): Possible values: 'account'

  • _id (string, required): Unique identifier Example: 67ac9a51106ee8311e911XXXX

  • liveMode (boolean, required): Indicates if it is in live mode Example: True

  • deleted (boolean, required): Indicates if deleted Example: False

  • name (string, required): Name Example: Estimate Name

  • currency (string, required): Currency code Example: USD

  • 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): Title Example: ESTIMATE

  • estimateNumberPrefix (string): Estimate number prefix Example: EST-

  • attachments (object[]): Attachments

    • id (string, required): Id of the file selected Example: 6241712be68f7a98102ba272

    • name (string, required): Name of the file Example: Electronics.pdf

    • url (string, required): URL of the file Example: https://example.com/digital-delivery

    • type (string, required): Type of the file

    • size (number, required): Size of the file Example: 10000

  • updatedBy (string): User Id of who last updated Example: 3HIpOF9NIc5ltriQXXXX

  • total (number, required): Total amount Example: 1222.03

  • createdAt (string, required): Timestamp when created Example: 2025-02-12T13:17:47.416Z

  • updatedAt (string, required): Timestamp when last updated Example: 2025-02-12T13:17:47.416Z

  • __v (number, required): Version number Example: 0

  • automaticTaxesEnabled (boolean, required): Indicates if automatic taxes are enabled for this estimate Example: False

  • termsNotes (string): Terms and conditions for the estimate, supports HTML markup Example: <p>All services are subject to availability.</p>

  • companyId (string, required): Company identifier associated with the estimate Example: COMP12345

  • contactDetails (object, required): Contact details for the estimate

  • issueDate (string, required): Date when the estimate was issued Example: 2023-06-15T00:00:00.000Z

  • expiryDate (string, required): Date when the estimate expires Example: 2023-07-15T00:00:00.000Z

  • sentBy (string): User who sent the estimate Example: user@example.com

  • automaticTaxesCalculated (boolean, required): Indicates if automatic taxes were calculated Example: True

  • meta (object, required): Additional metadata associated with the estimate

  • estimateActionHistory (string[], required): History of actions taken on the estimate

  • sentTo (object, required): Recipient details for the estimate

  • frequencySettings (object, required): Frequency settings for recurring estimates

  • lastVisitedAt (string, required): Timestamp when the estimate was last visited Example: 2023-06-20T08:30:00.000Z

  • totalamountInUSD (number, required): Total amount in USD Example: 1500.75

  • autoInvoice (object): Auto-invoice settings for the estimate

  • traceId (string, required): Trace ID for logging and debugging Example: 010c7a01-857f-4619-970d-xyxyxyxy

json
{
  "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
json
{}
401 - Unauthorized
json
{}
422 - Unprocessable Entity
json
{}

Example

curl -X POST 'https://services.leadconnectorhq.com/invoices/estimate' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "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": [
        {}
      ],
      "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",
  "estimateNumber": 1001,
  "issueDate": "2024-08-07",
  "expiryDate": "2024-08-10",
  "automaticTaxesEnabled": true,
  "meta": {
    "key": "value"
  },
  "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
  }
}'

Last updated October 26, 2026

Was this page helpful?