ZUzuper

Get Estimates

Changed on
get/v2/customer_portal/estimates

Request

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

Query parameters

pageinteger required
countinteger required
sort'DESC' | 'ASC' required
sort_by'estimate_no' | 'total' | 'created_at' | 'estimate_date' | 'expiry_date' required
filter.estimate_status'AWAIT_RESPONSE' | 'APPROVED' | 'DECLINED' | 'CLOSED' | 'CANCELED' | 'REQUEST_CHANGE'
filter.estimate_from_datestring date
filter.estimate_to_datestring date
filter.expiry_from_datestring date
filter.expiry_to_datestring date
filter.jobstring
filter.organizationstring
filter.propertystring
filter.keywordstring

Response

200

typestring
current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger

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",
      "customer": {
        "customer_uid": "3b9a2a60-3d5f-11ed-a77f-7d639323b89a",
        "customer_first_name": "Ashin",
        "customer_last_name": "customer OG"
      },
      "organization": {
        "organization_uid": "bd0a62d0-6cbc-11ee-83ad-4531910aaa26",
        "organization_name": "org17test2"
      },
      "total": 3608,
      "estimate_status": "AWAIT_RESPONSE",
      "custom_fields": [
        {
          "label": "Quatation Reference Number",
          "type": "SINGLE_LINE",
          "module_name": "PRODUCT",
          "_id": "66e9466e7c4d88844ad856db"
        }
      ],
      "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_options": [
        {
          "option_uid": "4d7718ab-54f5-4baf-b6fd-284d427b1e9a",
          "option_name": "Option 1"
        }
      ],
      "created_at": "2024-09-17T09:05:50.763Z",
      "updated_at": "2024-09-17T09:06:27.523Z",
      "estimate_no": 8028
    }
  ],
  "current_page_records": 1,
  "total_records": 103,
  "current_page": 1,
  "total_pages": 103
}

Changes