latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Leads

Convert a Lead to a Job

Converts an existing Lead to a Job and returns the resulting Job object.

post/v2/leads/{leadId}/convert

Path parameters

leadIdstring required

Example:LD-LwqGJnRwvZPaNe5E

The lead ID (prefix LD-).

Headers

Authorizationstring required

Example:Bearer <token>

Bearer Token

Response

The converted Job.

idstring

The ID of the job (prefix JOB-).

uuidstring

The UUID of the job.

serialIdnumber

The serial ID of the job.

namestring

The name of the job.

statusstring

The status of the job.

datestring date-time

The date and time when the job is scheduled.

endDatestring date-time

The date and time when the job is scheduled to end.

isAllDayboolean

Whether the job is all day.

isScheduledboolean

Whether the job is scheduled.

descriptionstring

The description of the job.

subTotalnumber

The subtotal of the job before tax and discounts.

discountAmountnumber

The job discount amount.

taxableAmountnumber

The taxable amount of the job.

taxPercentnumber

The tax percentage of the job.

taxAmountnumber

The tax amount of the job.

costingnumber

The cost amount of the job.

techExpensesnumber

The technician expenses of the job.

tipAmountnumber

The tip amount of the job.

totalPricenumber

The total price of the job.

amountDuenumber

The amount due for the job.

amountDueDatestring date-time

The date and time when the job amount is due.

convertedboolean

Whether the job was converted from a lead.

conversionDatestring date-time

The date and time when the job was converted from a lead (based on account timezone).

statusUpdatedstring date-time

The date and time when the job status was last updated (based on account timezone).

updatedAtstring date-time

The date and time when the job was last updated (based on account timezone).

createdAtstring date-time

The date and time when the job was created (based on account timezone).

Example response

{
  "id": "JOB-BA5r7o4bqzR9MONa",
  "uuid": "3YBIBO",
  "serialId": 12345,
  "name": "AC Repair",
  "status": "Submitted",
  "subStatus": {
    "id": "JSS-BA5r7o4bqzR9MONa",
    "name": "Follow Up"
  },
  "date": "2022-01-01 10:00:00",
  "endDate": "2022-01-01 10:00:00",
  "isScheduled": true,
  "jobType": {
    "id": "JT-8718036049ec4c4d",
    "name": "Repair"
  },
  "adGroup": {
    "id": "AG-71b8d7310acbf8cc",
    "name": "Ad Group 1"
  },
  "description": "This is a description of the job.",
  "subTotal": 946,
  "discountAmount": 10,
  "taxableAmount": 946,
  "taxPercent": 10.111,
  "taxAmount": 10.51,
  "costing": 10.51,
  "techExpenses": 12.51,
  "tipAmount": 43.51,
  "totalPrice": 956.51,
  "amountDue": 956.51,
  "amountDueDate": "2022-01-01 10:00:00",
  "converted": true,
  "clientInfo": {
    "clientId": "CL-OvmDp2yvv1yqMwRl",
    "serialId": 1023,
    "firstName": "John Doe",
    "lastName": "Doe",
    "companyName": "Sample Company name",
    "email": "client@workiz.com",
    "primaryExt": "619",
    "primaryPhone": "6195555555",
    "secondaryExt": "613",
    "secondaryPhone": "6195555555",
    "addressDetails": {
      "country": "US",
      "state": "Ohio",
      "city": "San Francisco",
      "zipCode": "94102",
      "address": "462 Powell St",
      "unit": "3422",
      "latitude": -76.2768398,
      "longitude": 36.9669587,
      "locationKey": "462 Powell St, San Francisco, Ohio 94102"
    },
    "serviceArea": {
      "id": "SA-71b8d7310acbf8cc",
      "name": "San Francisco"
    }
  },
  "maskedNumber": {
    "number": "6195551234",
    "extension": "042",
    "secondaryExtension": "043"
  },
  "team": [
    {
      "id": "USR-38c1ee5c4efa38a4",
      "name": "John Doe"
    }
  ],
  "lineItems": [
    {
      "id": "JLI-BA5r7o4bqzR9MONa",
      "productId": 1000,
      "type": "product",
      "name": "Deadbolt",
      "description": "Deadbolt replacement, any color and size",
      "price": 100,
      "quantity": 1,
      "total": 100,
      "cost": 100,
      "taxable": true,
      "discountable": true,
      "inventoryManaged": true,
      "inventorySync": true,
      "optionalConverted": true
    }
  ],
  "payments": [
    {
      "id": "PAY-BA5r7o4bqzR9MONa",
      "type": "Cash",
      "amount": 100,
      "tipAmount": 10
    }
  ],
  "tags": [
    {
      "id": "TAG-8cddc18e7b0458fa",
      "name": "Estimate"
    }
  ],
  "customFields": [
    {
      "id": "CF-eYLPK7198xVp6Z8q",
      "fieldName": "Custom Field 1",
      "value": "John Doe"
    }
  ],
  "notes": [
    {
      "id": "JNT-8cddc18e7b0458fa",
      "techName": "John Doe",
      "note": "This is a note",
      "timestamp": "2022-01-01 10:00:00"
    }
  ],
  "conversionDate": "2022-01-01 10:00:00",
  "statusUpdated": "2022-01-01 12:00:00",
  "updatedAt": "2022-01-01 12:00:00",
  "createdAt": "2022-01-01 10:00:00"
}