v1
latestOpenAPI 3.1.02026-07-2438302.6 MBGet Service Contract Details
get/service_contract/{contract_uid}
Path parameters
contract_uidstring required
Contract uid
Response
200
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",
"custom_fields": [
{
"label": "Gorgias ID",
"type": "SINGLE_LINE",
"_id": "643e549c2a73bd4593abe914"
}
],
"accounts": {
"ltv": 35684.49,
"receivables": 144696.3,
"credits": 204
},
"is_active": true,
"created_at": "2023-02-28T11:55:04.350Z",
"updated_at": "2023-09-14T05:55:06.374Z",
"customer_contact_no": {
"mobile": "+91303030303030"
}
},
"organization": {
"is_active": true,
"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_billing_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_uid": "11d86a70-8212-11eb-ab1f-1ddf213d24b4",
"no_of_customers": 58,
"custom_fields": [
{
"label": "LookUp",
"type": "LOOKUP",
"_id": "64cb3e0b223e99b1eb2d2803"
}
],
"created_at": "2021-03-11T02:32:48.537Z",
"updated_at": "2023-10-16T05:24:43.435Z"
},
"assets": [
{
"asset": {
"_id": "649181733039a6f2363afb2e",
"asset_uid": "7a7a3ee0-0f56-11ee-9b86-c9d61d432290",
"asset_code": "T002",
"asset_name": "Testing Product",
"asset_category": {
"category_name": "TEST",
"category_description": "test",
"category_uid": "48d3c590-859d-11eb-a715-479656013538"
},
"asset_serial_number": "1232132",
"asset_quantity": 1,
"is_active": true
},
"_id": "65321ce7e9dc3086d6c8140d"
}
],
"ref_no": "SC01",
"contract_name": "CFM Basic",
"description": "Basic Package",
"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",
"billing_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"
},
"customer_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"
},
"approval_status": "AWAIT_CUSTOMER_APPROVAL",
"custom_fields": [
{
"label": "Dealer",
"value": "Test",
"type": "SINGLE_LINE",
"_id": "65321ce7e9dc3086d6c8140e"
}
],
"payment_history": [
{
"payment_history_uid": "de358e63-2bfa-4c3d-a62e-7f03b84f26e2",
"total_amount": 153,
"status": "YET_TO_SEND",
"invoice_date": "2023-10-17T18:30:00.000Z",
"due_date": "2023-10-30T18:29:00.000Z",
"billing_date": "2023-10-19T18:30:00.000Z",
"_id": "65322611e9dc3086d6c83b92"
}
],
"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": {
"template_name": "Template 3001",
"template_description": "new twmp des",
"type": "INVOICE",
"template_uid": "8caccfc0-daa7-11e9-9ad0-c1a7d93adfe6"
}
},
"line_items": [
{
"line_item_type": "ITEM",
"line_item_uid": "32ce1d80-6f11-11ee-ab23-f576be9f85df",
"product_ref_id": {
"product_type": "SERVICE",
"product_name": "24 Hours Help Desk 1234",
"product_category": {
"category_name": "Miscellaneous",
"category_uid": "c4d9a2e0-7bc2-11e9-af27-a5e2b7a037f7"
},
"product_uid": "30b09080-0248-11ea-af45-bd1d48d9fadb",
"created_at": "2019-11-08T16:52:46.601Z",
"is_available": true,
"meta_data": [
{
"label": "Bin",
"value": "Bin #1",
"type": "SINGLE_ITEM",
"_id": "61eac124d17de78cb3febd9a"
}
],
"product_files": [
{
"file_url": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/dce53480-759f-11ea-bf4a-eb0dd07858c0.png",
"file_name": "h"
}
],
"product_id": "125",
"brand": "SOME_BRAND",
"specification": "Multi"
},
"product_id": "125",
"product_uid": "30b09080-0248-11ea-af45-bd1d48d9fadb",
"name": "24 Hours Help Desk 1234",
"brand": "SOME_BRAND",
"specification": "Multi",
"description": "Helpdesk",
"quantity": 3,
"available_quantity": 3,
"unit_price": 100,
"discount_type": "FIXED",
"total": 306,
"tax": {
"tax_name": "custom",
"tax_rate": 2,
"tax_amount": 6
},
"_id": "5e1c40fa35990a664930dea0"
}
],
"tax": [
{
"tax_id": {
"tax_uid": "61645e40-a2c8-11ed-b5a6-03828f316b1f",
"tax_name": "CGST",
"tax_rate": 18,
"is_active": true
},
"tax_uid": "61645e40-a2c8-11ed-b5a6-03828f316b1f",
"tax_name": "CGST",
"tax_percent": 18,
"_id": "65321ce7e9dc3086d6c81423"
}
],
"contract_subtotal": 306,
"contract_total": 306,
"contract_package": {
"package_name": "CFM Basic",
"package_description": "Basic Package",
"package_terms": 12,
"package_uid": "44769ec0-35ec-11ea-b910-fd8a0dd6897e",
"line_items": [
{
"product_ref_id": "5dc59d5e31b83c2935b0ae0e",
"product_id": "125",
"product_uid": "30b09080-0248-11ea-af45-bd1d48d9fadb",
"name": "24 Hours Help Desk 1234",
"brand": "SOME_BRAND",
"specification": "Multi",
"description": "Helpdesk",
"quantity": 3,
"available_quantity": 3,
"unit_price": 100,
"discount_type": "FIXED",
"total": 306,
"tax": {
"tax_name": "custom",
"tax_rate": 2,
"tax_amount": 6
},
"_id": "5e1c40fa35990a664930dea0"
}
],
"prefix": "Q1"
},
"template": {
"template_name": "Contract template 1",
"template_description": "test template",
"template": "<p>{{#each assigned_to}} {{user.first_name}} vbc {{/each}}<br></p> {{contract_package.package_name}} {{contract_package.package_description}} {{contract_number}} {{term_months}} {{contract_name}}",
"template_uid": "90fdcca0-f0f4-11ea-82a8-87c6418ce5fe",
"template_options": {
"format": "A4",
"orientation": "portrait",
"border": {
"top": "10mm",
"right": "10mm",
"bottom": "10mm",
"left": "10mm"
}
}
},
"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,
"attachments": [
{
"attachment_uid": "d72177c3-2f5b-4ee9-b16d-e89c3475d7d5",
"file_name": "Test attachment",
"url": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/15735070-6f11-11ee-ab23-f576be9f85df.png",
"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"
},
"_id": "65321ce7e9dc3086d6c81451",
"created_at": "2023-10-20T06:23:35.922Z"
}
],
"created_at": "2023-10-20T06:23:35.623Z",
"updated_at": "2023-10-20T07:02:41.950Z",
"contract_number": 868,
"items": {
"property": {
"property_uid": "de015800-4ddb-11ed-af58-17c563fc97f0",
"property_name": "Generator",
"property_image": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/9fbddc30-4ddb-11ed-a1e7-0d642a277542.jpg",
"property_address": {
"city": "Washington",
"state": "Kerala ",
"street": "Chennalode",
"country": "India",
"landmark": "Near Church",
"zip_code": "673122",
"geo_cordinates": [
11.6592096
],
"_id": "643e55b7a510b528e8780da7"
},
"custom_fields": [
{
"label": "Select",
"type": "SINGLE_ITEM",
"_id": "643e55b7a510b528e8780da8"
}
],
"is_active": true,
"created_at": "2023-07-28T05:12:14.049Z",
"updated_at": "2023-07-28T05:12:14.049Z"
}
}
}
}