v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get Service Contracts

get/service_contract

Query parameters

pageinteger

Page number to fetch

countinteger

Number of contracts in the page

sort'DESC' | 'ASC'

Sort order

sort_by'contract_number' | 'end_date' | 'created_at'

Sort type

filter.keywordstring

Keyword search based on Service Contracts name,number,ref_no,customer address,billing address and email

filter.is_activeboolean

Filter by active contracts

filter.is_deletedboolean

Filter by deleted contracts

filter.custom_fieldobject

Filter by contract's custom field

filter.organization_uidstring

Filter by organization uid

filter.updated_at_fromstring date

Filter by contract updated date from

filter.updated_at_tostring date

Filter by contract updated date to

filter.is_expiredboolean

Filter by contract's expire status

filter.approval_statusboolean

Filter by approval status

filter.contract_total_frominteger

Filter by contract total amount

filter.contract_total_tointeger

Filter by contract total amount

filter.await_approval_bystring

Filter by approver

filter.customerstring

Filter by customer uids

filter.end_fromstring date

Filter by contract end from

filter.end_tostring date

Filter by Contract end to

filter.assetstring

Filter by asset uids

filter.updated_atstring date

Filter by contract updated date

filter.contract_uidstring

Filter by contract uids

filter.expiring_fdstring date

Filter by expiring from date

filter.expiring_tdstring date

Filter by expiring to date

filter.propertystring

Filter by property uids

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "contract_uid": "32bc6a40-6f11-11ee-ab23-f576be9f85df",
      "customer": {
        "customer_uid": "bcf539f0-b75e-11ed-8a0f-090f81fad31e",
        "customer_first_name": "velmurugan",
        "customer_last_name": "k",
        "customer_email": "velmurugan.k@zuper.co",
        "is_active": true,
        "customer_contact_no": {
          "mobile": "+91303030303030"
        }
      },
      "organization": {
        "organization_address": {
          "city": "Chennai ",
          "state": "Tamil Nadu ",
          "street": "Turyaa Chennai, Old Mahabalipuram Road, Elango Nagar, Perungudi",
          "country": "India",
          "zip_code": "600041",
          "geo_cordinates": [
            12.9733389
          ],
          "first_name": "Org",
          "last_name": "SC",
          "phone_number": "8220131280",
          "email": "orgsc@abc.com"
        },
        "organization_name": "Ascendas",
        "organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/acb9ba40-8211-11eb-ab1f-1ddf213d24b4.jpg",
        "organization_email": "zupertest23@gmail.com",
        "organization_uid": "11d86a70-8212-11eb-ab1f-1ddf213d24b4",
        "no_of_customers": 58
      },
      "ref_no": "SC01",
      "contract_name": "CFM Basic",
      "start_date": "2023-10-23T04:30:00.000Z",
      "end_date": "2024-10-22T18:29:00.000Z",
      "term_months": 12,
      "activation_date": "2024-01-01T04:30:00.000Z",
      "approval_status": "AWAIT_CUSTOMER_APPROVAL",
      "custom_fields": [
        {
          "label": "Dealer",
          "value": "Test",
          "type": "SINGLE_LINE",
          "_id": "65321ce7e9dc3086d6c8140e"
        }
      ],
      "invoice_settings": {
        "billing_period": {
          "billing_period_uid": "e675db30-02ae-11ea-af45-bd1d48d9fadb",
          "billing_period_name": "Quarterly",
          "billing_period_type": "MONTHS",
          "billing_period_value": 3,
          "is_active": true
        },
        "generate_invoice_days": 2,
        "payment_term": {
          "payment_term_name": "ten day term",
          "no_of_days": 10,
          "payment_term_uid": "75afa880-db9f-11e9-a35c-3301ecc1dbf7"
        },
        "invoice_template": "5d83217cd32c2f2e7d78bab3"
      },
      "contract_subtotal": 306,
      "contract_total": 306,
      "created_by": {
        "user_uid": "c425fe39-2309-4d2b-87b8-5b4b65546ccb",
        "first_name": "Velmurugan",
        "last_name": "K",
        "email": "velmurugan.k@zuper.co",
        "designation": "Admin",
        "emp_code": "Z111",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
        "hourly_labor_charge": 120,
        "is_active": true,
        "created_at": "2022-11-02T10:35:52.000Z",
        "updated_at": "2023-01-23T09:20:16.000Z"
      },
      "is_active": true,
      "created_at": "2023-10-20T06:23:35.623Z",
      "updated_at": "2023-10-20T07:02:41.950Z",
      "contract_number": 868,
      "id": "undefined"
    }
  ],
  "total_records": 397,
  "current_page": 1,
  "total_pages": 40
}