v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get all Packages

get/invoice_estimate/package

Query parameters

pagestring
countstring
sort'DESC' | 'ASC'
sort_by'package_name' | 'created_at' | 'display_order'
filter.keywordstring
filter.is_activestring
filter.is_deletedboolean
filter.package_uidboolean

Response

200

typestring
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "display_order": 2,
      "package_uid": "72e0b360-3c21-11ee-82aa-858410f587b5",
      "package_name": "Applot 1",
      "package_description": "Sample Packages for companies",
      "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"
              }
            ],
            "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,
          "purchase_price": 1500,
          "discount_type": "FIXED",
          "total": 100,
          "_id": "668407fec67fdafeda3dbda3"
        }
      ],
      "is_active": true,
      "created_by": {
        "user_uid": "641aacc5-3a7a-4c3c-beec-fa6c186e37ec",
        "first_name": "def",
        "last_name": "S",
        "email": "defr.s@def.co",
        "designation": "Admin",
        "emp_code": "Z98",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/c5914720-043e-11ee-89dd-7d1eb09002c4.JPG",
        "hourly_labor_charge": 20,
        "is_active": true,
        "created_at": "2022-04-22T05:06:25.000Z",
        "updated_at": "2025-01-02T04:42:00.000Z"
      },
      "created_at": "2023-08-16T10:41:25.403Z",
      "updated_at": "2024-07-02T14:04:00.320Z",
      "sub_total": 1350,
      "total": 1350,
      "discount": {
        "type": "PERCENTAGE",
        "discount_applicability": "LINE_ITEM",
        "discount_label": "Discount"
      },
      "id": "64dca7d5a5f7ee4f80e43d07"
    }
  ],
  "total_records": 5,
  "current_page": 1,
  "total_pages": 1
}