Get Estimate Details

Changed on
get/v2/customer_portal/estimates/{estimate_uid}

Request

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

Path parameters

estimate_uidstring required

uid of estimates

Response

200

typestring

Example response

{
  "type": "success",
  "data": {
    "estimate_uid": "3330a130-f60d-477e-b12e-0f0011eb5b4c",
    "estimate_date": "2024-09-16T13:00:00.000Z",
    "expiry_date": "2024-09-17T12:59:00.000Z",
    "organization": {
      "organization_uid": "bd0a62d0-6cbc-11ee-83ad-4531910aaa26",
      "organization_name": "org17test2",
      "organization_email": "org17test2@mail.com",
      "no_of_customers": 4
    },
    "customer_billing_address": {
      "city": "Kolkata",
      "state": "West Bengal",
      "street": "SDF Building, GP Block, Sector V, Bidhannagar, Calcutta, India",
      "zip_code": "700091",
      "geo_cordinates": [
        22.5686855
      ]
    },
    "customer_service_address": {
      "landmark": "near jain college",
      "city": "Thoraipakkam ",
      "state": "Tamil Nadu ",
      "street": "Jain College, D B Jain College main enterence, Jothi Nagar",
      "zip_code": "600097",
      "geo_cordinates": [
        12.9469543
      ],
      "first_name": "Ashin",
      "last_name": "customer OG",
      "phone_number": "8301907278",
      "email": "ashinthankachan1999@gmail.com"
    },
    "sub_total": 3280,
    "discount": {
      "type": "PERCENTAGE",
      "discount_applicability": "TRANSACTION",
      "discount_label": "Discount"
    },
    "total": 3608,
    "taxation_meta": {
      "current_status": "SAVED"
    },
    "estimate_status": "AWAIT_RESPONSE",
    "custom_fields": [
      {
        "label": "Quatation Reference Number",
        "type": "SINGLE_LINE",
        "module_name": "PRODUCT",
        "_id": "66e9466e7c4d88844ad856db"
      }
    ],
    "status_history": [
      {
        "status_name": "DRAFT",
        "done_by_type": "EMPLOYEE",
        "_id": "66e9466e7c4d88844ad856e8",
        "created_at": "2024-09-17T09:05:50.757Z"
      }
    ],
    "public_url": "http://localhost:4500/customer_portal/estimates?company_uid=6c287db0-ff7c-11e7-b3a8-29b417a4f3fa&estimate_uid=3330a130-f60d-477e-b12e-0f0011eb5b4c&to=ashinthankachan1999@gmail.com",
    "financing": {
      "promo_message": "From $164.67/month at 8.90% APR for 24 months, totaling $3951.96*.",
      "is_enabled": true
    },
    "is_proposal": true,
    "proposal_title": "Proposal for Ashin customer OG",
    "proposal_template": {
      "template_uid": "84c44eb0-4262-11ee-b1a1-7372ef614376",
      "template_name": "Proposal Template"
    },
    "proposal_options": [
      {
        "option_uid": "4d7718ab-54f5-4baf-b6fd-284d427b1e9a",
        "option_name": "Option 1",
        "option_description": "test",
        "package": {
          "package_name": "Bug bash package 1",
          "package_description": "Desc for bug bash package",
          "master_package": {
            "package_uid": "70c4bb10-5cf8-11ee-bf89-7dff9a634b35",
            "package_name": "Bug bash package 1",
            "package_description": "Desc for bug bash package",
            "created_at": "2023-09-27T05:41:00.869Z",
            "updated_at": "2023-09-27T05:48:23.220Z"
          }
        },
        "line_items": [
          {
            "line_item_uid": "7860dc90-5cf9-11ee-bf89-7dff9a634b35",
            "line_item_type": "HEADER",
            "name": "Group 1 Header",
            "discount_type": "FIXED",
            "_id": "6513c214f42678bea5fc7fa5"
          }
        ],
        "discount": {
          "type": "PERCENTAGE",
          "discount_applicability": "LINE_ITEM",
          "discount_label": "Discount"
        },
        "sub_total": 1903,
        "total": 1903,
        "_id": "66e9466e7c4d88844ad856e9"
      }
    ],
    "created_at": "2024-09-17T09:05:50.763Z",
    "updated_at": "2024-09-17T09:06:27.523Z",
    "estimate_no": 8028,
    "__v": 1
  }
}

Changes