ZUzuper

Get Service Contracts

Changed on
get/v2/customer_portal/service_contracts

Request

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

Query parameters

pagestring required
countinteger required
sort'DESC' | 'ASC'
sort_by'contract_name' | 'contract_number' | 'end_date' | 'created_at'
filter.keywordstring
filter.end_date_fromstring date required
filter.end_date_tostring date required
filter.asset_uidstring
filter.jobstring
filter.propertystring

Response

200

typestring
current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "contract_uid": "8658d8eb-9192-451d-935d-212c53c90a11",
      "customer": {
        "customer_uid": "3b9a2a60-3d5f-11ed-a77f-7d639323b89a",
        "customer_first_name": "Ashin",
        "customer_last_name": "customer OG",
        "customer_email": "ashinthankachan1999@gmail.com",
        "customer_contact_no": {
          "mobile": "8301907278",
          "home": "123123",
          "work": "8301907278"
        },
        "is_active": true
      },
      "organization": {
        "organization_uid": "bd0a62d0-6cbc-11ee-83ad-4531910aaa26",
        "organization_name": "org17test2",
        "organization_email": "org17test2@mail.com",
        "no_of_customers": 4
      },
      "ref_no": "CON-0123",
      "contract_name": "new bulk test 3",
      "start_date": "2023-12-14T08:00:00.000Z",
      "end_date": "2024-04-13T23:59:59.000Z",
      "term_months": 4,
      "approval_status": "CUSTOMER_APPROVED",
      "custom_fields": [
        {
          "label": "Dealer",
          "type": "SINGLE_LINE",
          "module_name": "PRODUCT",
          "_id": "66c80a63beb9faed53968219"
        }
      ],
      "invoice_settings": {
        "billing_period": {
          "billing_period_uid": "0b3b4ef0-02af-11ea-af45-bd1d48d9fadb",
          "billing_period_name": "Yearly",
          "billing_period_type": "MONTHS",
          "billing_period_value": 12,
          "is_active": true
        },
        "generate_invoice_days": 5,
        "payment_term": {
          "payment_term_name": "Week",
          "no_of_days": 7,
          "payment_term_uid": "8cb27ac0-7861-11eb-ac8f-57f366bb3aaf"
        },
        "invoice_template": {
          "template_name": "Template 3001",
          "template_description": "new twmp des",
          "type": "INVOICE",
          "template_uid": "8caccfc0-daa7-11e9-9ad0-c1a7d93adfe6"
        }
      },
      "contract_subtotal": 500,
      "contract_total": 635,
      "is_active": true,
      "created_at": "2024-08-23T04:04:51.624Z",
      "updated_at": "2024-08-28T06:53:47.061Z",
      "contract_number": 1100
    }
  ],
  "current_page_records": 1,
  "total_records": 14,
  "current_page": 1,
  "total_pages": 14
}

Changes