WOworkiz
Estimates

Retrieve a single Estimate

Changed on

Retrieves a single Estimate by its ID.

get/v2/estimates/{id}

Request

Path parameters

idstring required
Example:ES-LwqGJnRwvZPaNe5E

The estimate ID (prefix ES-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

The requested Estimate.

idstring

The ID of the estimate (prefix ES-).

statusstring

The status of the estimate.

serialIdstring

The interval of the estimate.

namestring

The name of the estimate.

descriptionstring

The description of the estimate.

notesstring

The estimate note.

imageUrlstring

The image URL of the estimate.

clientIdstring

The ID of the associated client (prefix CL-).

jobIdstring

The ID of the associated job or lead (prefix JOB- or LD-).

discountAmountnumber

The estimate discount amount.

taxPercentnumber

The estimate tax percent.

taxableAmountnumber

The estimate taxable amount.

taxAmountnumber

The estimate tax amount.

isDepositPercentageboolean

The estimate deposit percentage or amount.

depositnumber

The deposit amount or percentage needed.

subTotalnumber

The estimate subtotal before tax and discounts.

totalnumber

The total amount of the estimate.

declineReasonstring

The decline reason of the estimate.

sentDatestring date-time

The sent date of the estimate.

estimateDatestring date-time

The date of the estimate.

lastViewedDatestring date-time

The last viewed date of the estimate.

statusUpdatedAtstring date-time

The date and time the status was last updated.

updatedstring date-time

The date and time the estimate was last updated.

createdstring date-time

The date and time the estimate was created.

Example response

{
  "id": "ES-LwqGJnRwvZPaNe5E",
  "status": "Pending",
  "serialId": "1-1",
  "name": "Estimate 1",
  "description": "This is a description for the estimate",
  "notes": "This is a note for the estimate",
  "imageUrl": "https://example.com/image.png",
  "clientId": "CL-LwqGJnRwvZPaNe5E",
  "jobId": "JOB-BA5r7o4bqzR9MONa",
  "discountAmount": 10,
  "taxPercent": 10,
  "taxableAmount": 100,
  "taxAmount": 10,
  "isDepositPercentage": true,
  "deposit": 100,
  "subTotal": 10,
  "total": 10,
  "declineReason": "This is a decline reason for the estimate",
  "lineItems": [
    {
      "id": "ELI-BA5r7o4bqzR9MONa",
      "productId": 1000,
      "name": "Deadbolt",
      "description": "Deadbolt replacement, any color and size",
      "price": 100,
      "quantity": 1,
      "total": 100,
      "cost": 100,
      "taxable": true,
      "discountable": true,
      "inventoryManaged": true,
      "inventorySync": true,
      "optionalConverted": true
    }
  ],
  "payments": [
    {
      "id": "PAY-BA5r7o4bqzR9MONa",
      "date": "2026-01-01 10:00:00",
      "amount": 250.5,
      "tipAmount": 10,
      "type": "charge",
      "status": "succeeded",
      "estimateId": "ES-LwqGJnRwvZPaNe5E",
      "confirmationCode": "ch_3QwErTyUiOp12345",
      "collectedById": "USR-38c1ee5c4efa38a4"
    }
  ],
  "attachments": [
    {
      "id": "FLE-BA5r7o4bqzR9MONa",
      "name": "file.pdf",
      "fileUrl": "https://example.com/file.pdf"
    }
  ],
  "signatureImage": {
    "id": "IMG-BA5r7o4bqzR9MONa",
    "signedByName": "John Doe",
    "imageUrl": "https://example.com/image.png"
  },
  "sentDate": "2026-01-01 00:00:00",
  "estimateDate": "2026-01-01 00:00:00",
  "lastViewedDate": "2026-01-01 00:00:00",
  "statusUpdatedAt": "2026-01-01 00:00:00",
  "updated": "2026-01-01 00:00:00",
  "created": "2026-01-01 00:00:00"
}

Changes

  • a2110eaa32f2Revision changes
    • warning

      added the new bank_transfer enum value to the // response property for the response status

    • warning

      added the new bank_transfer_offline enum value to the // response property for the response status

    • warning

      added the new cash enum value to the // response property for the response status

    • warning

      added the new cash_app enum value to the // response property for the response status

    • warning

      added the new charge enum value to the // response property for the response status

    • warning

      added the new check enum value to the // response property for the response status

    • warning

      added the new check_deposit enum value to the // response property for the response status

    • warning

      added the new consumer_financing enum value to the // response property for the response status

    • warning

      added the new credit enum value to the // response property for the response status

    • warning

      added the new debit_offline enum value to the // response property for the response status

    • warning

      added the new installments enum value to the // response property for the response status

    • warning

      added the new interac enum value to the // response property for the response status

    • warning

      added the new refund enum value to the // response property for the response status

    • warning

      added the new refund_offline enum value to the // response property for the response status

    • warning

      added the new venmo enum value to the // response property for the response status

    • warning

      added the new zelle enum value to the // response property for the response status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status