get/estimate/{estimate_uid}

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/estimate/{estimate_uid}
  • Auth
    API key in header x-api-key

Path parameters

estimate_uidstring required

Response

200

typestring

Example response

{
  "type": "success",
  "data": {
    "estimate_uid": "bde94a1f-6b76-4e6e-b2bb-2c3e985923fd",
    "prefix": "10000",
    "reference_no": "12345653311",
    "estimate_description": "<p>test</p>",
    "plain_text_description": "test",
    "markdown_description": "test",
    "estimate_date": "2025-01-05T18:30:00.000Z",
    "expiry_date": "2025-01-06T18:29:00.000Z",
    "customer": {
      "customer_uid": "d41e9fe0-6442-11ee-b5d5-49505c31565c",
      "customer_first_name": "Hari",
      "customer_last_name": "V",
      "customer_organization": {
        "organization_uid": "cf1940f0-1b26-11ee-a61c-c7daced78d3d",
        "organization_name": "Acme Inc.",
        "is_active": true,
        "custom_fields": [
          {
            "label": "HubSpot Company ID",
            "type": "SINGLE_LINE",
            "_id": "663b7a242c0524815c8079a4"
          }
        ],
        "created_at": "2023-07-05T11:26:39.231Z",
        "updated_at": "2024-07-26T05:14:58.331Z",
        "organization_address": {
          "city": "Chennai",
          "state": "Tamil Nadu",
          "street": "WorkEZ Willow Square Guindy - Managed Offices and Coworking Spaces, 1st Street, Thiru Vi Ka Industrial Estate, SIDCO Industrial Estate, Guindy",
          "country": "India",
          "zip_code": "600032",
          "geo_cordinates": [
            13.0104643
          ],
          "point_coordinates": {
            "type": "Point",
            "coordinates": [
              80.2090733
            ]
          }
        },
        "organization_billing_address": {
          "city": "Chennai",
          "state": "Tamil Nadu",
          "street": "WorkEZ Urban Square OMR - Coworking Spaces, Elango Nagar, Perungudi",
          "zip_code": "600041",
          "geo_cordinates": [
            12.9730624
          ],
          "point_coordinates": {
            "type": "Point",
            "coordinates": [
              80.2505897
            ]
          }
        },
        "organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/fb1ecfb0-7f91-11ee-93cb-5be0a22f4e69.png",
        "organization_timezone": "Africa/Cairo"
      },
      "customer_email": "hariv+90@gmail.com",
      "customer_all_addresses": [
        {
          "city": "Mumbai",
          "street": "Phoenix Marketcity, Lal Bahadur Shastri Marg, Patelwadi.Kurla, Kamani, Kurla West, Kurla",
          "country": "India",
          "zip_code": "400070",
          "_id": "658bc57c65e21e305757833e"
        }
      ],
      "customer_address": {
        "city": "Mumbai",
        "street": "Phoenix Marketcity, Lal Bahadur Shastri Marg, Patelwadi.Kurla, Kamani, Kurla West, Kurla",
        "country": "India",
        "zip_code": "400070"
      },
      "customer_billing_address": {
        "city": "Mumbai",
        "street": "Phoenix Marketcity, Lal Bahadur Shastri Marg, Patelwadi.Kurla, Kamani, Kurla West, Kurla",
        "country": "India",
        "zip_code": "400070"
      },
      "custom_fields": [
        {
          "label": "Quickbooks ID",
          "value": "400",
          "_id": "658bc57c65e21e3057578340"
        }
      ],
      "is_active": true,
      "created_at": "2023-10-06T12:21:08.483Z",
      "updated_at": "2024-03-04T06:48:31.770Z"
    },
    "organization": {
      "organization_uid": "cf1940f0-1b26-11ee-a61c-c7daced78d3d",
      "organization_name": "Acme Inc.",
      "no_of_customers": 27,
      "is_active": true,
      "custom_fields": [
        {
          "label": "HubSpot Company ID",
          "type": "SINGLE_LINE",
          "_id": "663b7a242c0524815c8079a4"
        }
      ],
      "created_at": "2023-07-05T11:26:39.231Z",
      "updated_at": "2024-07-26T05:14:58.331Z",
      "organization_address": {
        "city": "Chennai",
        "state": "Tamil Nadu",
        "street": "WorkEZ Willow Square Guindy - Managed Offices and Coworking Spaces, 1st Street, Thiru Vi Ka Industrial Estate, SIDCO Industrial Estate, Guindy",
        "country": "India",
        "zip_code": "600032",
        "geo_cordinates": [
          13.0104643
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2090733
          ]
        }
      },
      "organization_billing_address": {
        "city": "Chennai",
        "state": "Tamil Nadu",
        "street": "WorkEZ Urban Square OMR - Coworking Spaces, Elango Nagar, Perungudi",
        "zip_code": "600041",
        "geo_cordinates": [
          12.9730624
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2505897
          ]
        }
      },
      "organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/fb1ecfb0-7f91-11ee-93cb-5be0a22f4e69.png",
      "organization_timezone": "Africa/Cairo"
    },
    "property": {
      "is_active": true,
      "custom_fields": [
        {
          "label": "Time Input",
          "type": "TIME",
          "_id": "672b478e3ad6c2466d11b684"
        }
      ],
      "property_address": {
        "city": "Chennai",
        "state": "Tamil Nadu",
        "street": "RMZ Software Park,Pvt Ltd., Mount Poonamallee Road, Porur",
        "country": "India",
        "zip_code": "600125",
        "geo_cordinates": [
          13.0310078
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.1682374
          ]
        },
        "_id": "672b478e3ad6c2466d11b688"
      },
      "property_image": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/7fc5997a-8efb-4759-86ff-10ef51c3246b.jpg",
      "no_of_jobs": 1,
      "property_name": "Acme Property",
      "property_uid": "81f5c870-9c2b-11ef-a9ff-dd3068964df0"
    },
    "customer_billing_address": {
      "city": "Chennai",
      "state": "Tamil Nadu",
      "street": "WorkEZ Urban Square OMR - Managed Offices and Coworking Spaces, Elango Nagar, Perungudi",
      "zip_code": "600041",
      "geo_cordinates": [
        12.9730624
      ]
    },
    "customer_service_address": {
      "city": "Mumbai",
      "street": "Phoenix Marketcity, Lal Bahadur Shastri Marg, Patelwadi.Kurla, Kamani, Kurla West, Kurla",
      "zip_code": "400070",
      "first_name": "Hari",
      "last_name": "V",
      "email": "hariv+90@gmail.com"
    },
    "job": {
      "job_uid": "366a23b0-d9f3-11ee-9054-0be1fec3fea9",
      "prefix": "V2-004",
      "job_title": "test7",
      "job_description": "<p>Tower <strong>maintenance</strong></p>",
      "job_category": {
        "estimated_duration": {
          "days": 2
        },
        "category_name": "Tower Maintenance 1",
        "category_uid": "5aa538a0-e38e-11ea-9951-bd17f6a7ddb8",
        "category_color": "#4F46E5"
      },
      "job_priority": "URGENT",
      "scheduled_start_time": "2019-02-04T08:00:00.000Z",
      "scheduled_end_time": "2019-02-06T08:00:00.000Z",
      "due_date": "2024-03-31T18:29:59.000Z",
      "customer_address": {
        "city": "Mumbai",
        "street": "Phoenix Marketcity, Lal Bahadur Shastri Marg, Patelwadi.Kurla, Kamani, Kurla West, Kurla",
        "zip_code": "400070",
        "first_name": "Hari",
        "last_name": "V",
        "email": "hariv+90@gmail.com",
        "point_coordinates": {
          "type": "Point"
        }
      },
      "customer_billing_address": {
        "city": "Chennai",
        "state": "Tamil Nadu",
        "street": "WorkEZ Urban Square OMR - Managed Offices and Coworking Spaces, Elango Nagar, Perungudi",
        "zip_code": "600041",
        "geo_cordinates": [
          12.9730624
        ]
      },
      "custom_fields": [
        {
          "label": "Feelings",
          "type": "MULTI_LINE",
          "module_name": "PRODUCT",
          "hide_field": true,
          "_id": "65e56ebf53d05d1cd388ca29"
        }
      ],
      "created_at": "2024-03-04T06:48:31.736Z",
      "updated_at": "2024-04-03T18:29:59.254Z",
      "work_order_number": 16147
    },
    "sub_total": 1350,
    "discount": {
      "type": "FIXED",
      "discount_applicability": "TRANSACTION",
      "discount_label": "Discount"
    },
    "total": 1350,
    "remarks": "default remarks for quote by ak",
    "template": {
      "template_name": "Template 1(dont choose)",
      "template": "<style>* { box-sizing: border-box; } body {margin: 0;}*{font-size:12px;font-family:sans-serif;box-sizing:border-box;}table{break-inside:avoid;overflow-x:visible !important;overflow-y:visible !important;border-top-width:initial !important;border-right-width:initial !important;border-bottom-width:initial !important;border-left-width:initial !important;border-top-style:none !important;border-right-style:none !important;border-bottom-style:none !important;border-left-style:none !important;border-top-color:initial !important;border-right-color:initial !important;border-bottom-color:initial !important;border-left-color:initial !important;border-image-source:initial !important;border-image-slice:initial !important;border-image-width:initial !important;border-image-outset:initial !important;border-image-repeat:initial !important;}tr, th, td{padding-top:5px;padding-right:5px;padding-bottom:5px;padding-left:5px;border-top-width:initial !important;border-right-width:initial !important;border-bottom-width:initial !important;border-left-width:initial !important;border-top-style:none !important;border-right-style:none !important;border-bottom-style:none !important;border-left-style:none !important;border-top-color:initial !important;border-right-color:initial !important;border-bottom-color:initial !important;border-left-color:initial !important;border-image-source:initial !important;border-image-slice:initial !important;border-image-width:initial !important;border-image-outset:initial !important;border-image-repeat:initial !important;}thead{display:table-header-group;}tfoot{display:table-row-group;}tr{break-inside:avoid;break-before:avoid;}body{margin-top:0px;margin-right:0px;margin-bottom:0px;margin-left:0px;}</style>{{formatCurrency total 'USA' 'USD'}}",
      "template_description": "new twmp des",
      "type": "ESTIMATE",
      "template_uid": "014c1490-d84f-11e9-b7cf-118df12e5532",
      "template_options": {
        "format": "A4",
        "orientation": "portrait",
        "border": {
          "top": "10mm",
          "right": "10mm",
          "bottom": "10mm",
          "left": "10mm"
        }
      },
      "render_engine": "PUPPETEER"
    },
    "tags": [
      "test"
    ],
    "taxation_meta": {
      "current_status": "SAVED"
    },
    "estimate_status": "DRAFT",
    "custom_fields": [
      {
        "label": "Text Input",
        "value": "test",
        "type": "SINGLE_LINE",
        "module_name": "PRODUCT",
        "_id": "677b7bac020106724452218c"
      }
    ],
    "status_history": [
      {
        "status_name": "DRAFT",
        "done_by": {
          "user_uid": "48625036-fef6-4637-99e7-f09377a4f9ba",
          "first_name": "3e",
          "last_name": "M",
          "email": "3e.m@zuper.co",
          "designation": "Tech",
          "emp_code": "1234",
          "prefix": "Z22",
          "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
          "hourly_labor_charge": 20,
          "is_active": true,
          "created_at": "2024-07-05T06:42:02.000Z",
          "updated_at": "2024-12-26T12:12:07.000Z"
        },
        "done_by_type": "EMPLOYEE",
        "_id": "677b7595f00d6b1ca76601c4",
        "created_at": "2025-01-06T06:17:57.942Z"
      }
    ],
    "deposit": {
      "status": "NOT_COLLECTED"
    },
    "is_active": true,
    "sold_by_user": {
      "user_uid": "50689376-6348-41dd-81e3-9d75dc73027d",
      "first_name": "Maruthu",
      "last_name": "Raja",
      "email": "Maruthu@zuper.co",
      "designation": "Test",
      "emp_code": "5000",
      "work_phone_number": "8220131280",
      "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/04a37b90-9a53-11ee-8187-39c77e7ec503.webp",
      "hourly_labor_charge": 20,
      "is_active": true,
      "created_at": "2023-05-05T06:57:26.000Z",
      "updated_at": "2023-12-14T07:33:04.000Z"
    },
    "created_by": {
      "user_uid": "48625036-fef6-4637-99e7-f09377a4f9ba",
      "first_name": "3e",
      "last_name": "M",
      "email": "3e.m@zuper.co",
      "designation": "Tech",
      "emp_code": "1234",
      "prefix": "Z22",
      "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
      "hourly_labor_charge": 20,
      "is_active": true,
      "created_at": "2024-07-05T06:42:02.000Z",
      "updated_at": "2024-12-26T12:12:07.000Z"
    },
    "public_url": "https://stagingv2.zuperpro.com/api/customer_portal/estimates?company_uid=6c287db0-ff7c-11e7-b3a8-29b417a4f3fa&estimate_uid=bde94a1f-6b76-4e6e-b2bb-2c3e985923fd&to=hariv+90@gmail.com",
    "deposit_payment_url": "https://stagingv2.zuperpro.com/api/customer_portal/estimates/collect_deposit?company_uid=6c287db0-ff7c-11e7-b3a8-29b417a4f3fa&estimate_uid=bde94a1f-6b76-4e6e-b2bb-2c3e985923fd",
    "financing": {
      "promo_message": "From $61.61/month at 8.90% APR for 24 months, totaling $1478.70*.",
      "is_enabled": true
    },
    "is_proposal": true,
    "proposal_title": "Proposal for Hari V 2",
    "proposal_template": {
      "template_uid": "84c44eb0-4262-11ee-b1a1-7372ef614376",
      "template_name": "Proposal Template"
    },
    "proposal_options": [
      {
        "option_uid": "ba531e08-d8d0-473c-bba1-a6373e8c5eed",
        "option_name": "Option 3",
        "option_description": "test",
        "deposit": 500,
        "package": {
          "package_name": "Applot 1",
          "package_description": "Sample Packages for companies",
          "master_package": {
            "package_uid": "72e0b360-3c21-11ee-82aa-858410f587b5",
            "package_name": "Applot 1",
            "package_description": "Sample Packages for companies",
            "created_at": "2023-08-16T10:41:25.403Z",
            "updated_at": "2024-07-02T14:04:00.320Z"
          }
        },
        "line_items": [
          {
            "line_item_uid": "b4c7ff9d-412f-4e90-ba2b-ecefabdf66b1",
            "line_item_type": "ITEM",
            "product_ref_id": {
              "product_uid": "7aab9620-5e89-11ee-a16d-d973f75ee849",
              "prefix": "PT",
              "product_id": "7878787878",
              "product_category": {
                "category_name": "Civil Items",
                "category_uid": "effde4f0-480d-11ea-85e2-91cf2fb0b4bb"
              },
              "product_name": "Boat Watch",
              "product_type": "PRODUCT",
              "meta_data": [
                {
                  "label": "QB Product ID",
                  "value": "2286",
                  "_id": "66b34b54585a33f2849e25e0"
                }
              ],
              "price": 1500,
              "purchase_price": 1500,
              "has_custom_tax": true,
              "created_at": "2023-09-29T05:31:45.671Z",
              "updated_at": "2024-08-09T09:48:11.948Z",
              "product_no": 702
            },
            "product_id": "7878787878",
            "product_uid": "7aab9620-5e89-11ee-a16d-d973f75ee849",
            "image": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/44f7b900-5e89-11ee-a16d-d973f75ee849.png",
            "name": "Boat Watch",
            "brand": "Boat Watch",
            "specification": "New Smart Watchs",
            "description": "Health Insurance that stays with you forever ",
            "uom": "1",
            "quantity": 1,
            "unit_price": 100,
            "product_type": "PRODUCT",
            "purchase_price": 1500,
            "discount_type": "FIXED",
            "total": 100,
            "_id": "668407fec67fdafeda3dbda3"
          }
        ],
        "addons": [
          {
            "line_item_uid": "b4c7ff9d-412f-4e90-ba2b-ecefabdf66b1",
            "line_item_type": "ITEM",
            "product_ref_id": {
              "product_uid": "7aab9620-5e89-11ee-a16d-d973f75ee849",
              "prefix": "PT",
              "product_id": "7878787878",
              "product_category": {
                "category_name": "Civil Items",
                "category_uid": "effde4f0-480d-11ea-85e2-91cf2fb0b4bb"
              },
              "product_name": "Boat Watch",
              "product_type": "PRODUCT",
              "meta_data": [
                {
                  "label": "QB Product ID",
                  "value": "2286",
                  "_id": "66b34b54585a33f2849e25e0"
                }
              ],
              "price": 1500,
              "purchase_price": 1500,
              "has_custom_tax": true,
              "created_at": "2023-09-29T05:31:45.671Z",
              "updated_at": "2024-08-09T09:48:11.948Z",
              "product_no": 702
            },
            "product_id": "7878787878",
            "product_uid": "7aab9620-5e89-11ee-a16d-d973f75ee849",
            "image": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/44f7b900-5e89-11ee-a16d-d973f75ee849.png",
            "name": "Boat Watch",
            "brand": "Boat Watch",
            "specification": "New Smart Watchs",
            "description": "Health Insurance that stays with you forever ",
            "uom": "1",
            "quantity": 1,
            "unit_price": 100,
            "product_type": "PRODUCT",
            "purchase_price": 1500,
            "discount_type": "FIXED",
            "total": 100,
            "_id": "668407fec67fdafeda3dbda3"
          }
        ],
        "discount": {
          "type": "PERCENTAGE",
          "discount_applicability": "LINE_ITEM",
          "discount_label": "Discount"
        },
        "tax": [
          {
            "tax_id": {
              "tax_uid": "d7e1bc30-fbbd-11ee-b23b-b9743bfe06c8",
              "tax_name": "GST",
              "tax_rate": 8,
              "is_active": true
            },
            "tax_uid": "d7e1bc30-fbbd-11ee-b23b-b9743bfe06c8",
            "tax_name": "GST",
            "tax_percent": 8,
            "tax_amount": 108,
            "_id": "677b7bac0201067244522192"
          }
        ],
        "financing": {
          "promo_message": "From $61.61/month at 8.90% APR for 24 months, totaling $1478.70*."
        },
        "sub_total": 1350,
        "total": 1350,
        "_id": "677b7bac020106724452218f"
      }
    ],
    "attachments": [
      {
        "attachment_uid": "d9136912-db4e-439b-a90f-113f389d2d97",
        "file_name": "errors.doc",
        "url": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/952338e7-c752-4652-9f53-17103ec51235.doc",
        "created_by": {
          "user_uid": "48625036-fef6-4637-99e7-f09377a4f9ba",
          "first_name": "3e",
          "last_name": "M",
          "email": "3e.m@zuper.co",
          "designation": "Tech",
          "emp_code": "1234",
          "prefix": "Z22",
          "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
          "hourly_labor_charge": 20,
          "is_active": true,
          "created_at": "2024-07-05T06:42:02.000Z",
          "updated_at": "2024-12-26T12:12:07.000Z"
        },
        "_id": "677b75962d9c5266f268dd63",
        "created_at": "2025-01-06T06:17:58.291Z"
      }
    ],
    "created_at": "2025-01-06T06:17:57.958Z",
    "updated_at": "2025-01-06T06:43:57.625Z",
    "estimate_no": 8493
  }
}

Changes

    • info

      api operation id get_estimate-estimate-uid removed and replaced with get-a-proposal

    • 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