Kickserv APIv2 - Job Object
This documention is neither written nor endorsed by Kickserv. It has not been reviewed by Kickserv for accuracy and the API is entirely unsupported. It may work, it may not.
You are responsible for anything that you do using the API and Kickserv can't undo it for you. Use at your own risk.
Mouseover the JSON key to see a brief description of each key. Keys that either haven't been identified (or that we haven't gotten around to adding yet) will show 'XXX'. Keys that are light gray are obsolete/legacy but still are returned in API responses.
Some keys appear to be remnants either of older Kickserv releases, upcoming features that have yet to be released, used for integrations we don't use, or used in corner cases that we simply haven't run into yet. Some keys, such as 'customer_ref_list_id', we've never seen populated by anything other than 'null' which really limits our ability to figure out what they're for. The example below is a relativley basic job without a lot of frills. Some sections such as job charges have been (or will be) placed in separate documents to keep this manageable. If you spot a mistake or know the purpose of an undescribed key please let us know by emailing kickservapi@veildg.com.
{
"id": 39497130,
"customer_id": 6667788,
"account_id": 999,
"job_number": 86000,
"created_at": "2022-05-17T10:04:14-04:00",
"name": "Bathtub Realignment",
"scheduled_on": null,
"completed_on": null,
"ok_to_sync": false,
"txn_id": null,
"edit_sequence": null,
"ref_number": null,
"subtotal": "0.0",
"tax": "0.0",
"balance_remaining": "0.0",
"estimate_type": null,
"self_service": false,
"custom_text1": null,
"custom_number1": null,
"custom_datetime1": null,
"custom_text2": null,
"custom_number2": null,
"custom_datetime2": null,
"custom_text3": null,
"custom_number3": null,
"custom_datetime3": null,
"custom_text4": null,
"custom_number4": null,
"custom_datetime4": null,
"custom_text5": null,
"custom_number5": null,
"custom_datetime5": null,
"custom_text6": null,
"custom_number6": null,
"custom_datetime6": null,
"custom_text7": null,
"custom_number7": null,
"custom_datetime7": null,
"custom_text8": null,
"custom_number8": null,
"custom_datetime8": null,
"custom_text9": null,
"custom_number9": null,
"custom_datetime9": null,
"custom_text10": null,
"custom_number10": null,
"custom_datetime10": null,
"total": "0.0",
"recurring_job_id": null,
"recurring_interval": null,
"updated_at": "2022-05-17T10:04:36-04:00",
"job_type_id": 177484,
"job_status_id": null,
"recurring_end_date": null,
"customer_ref_list_id": null,
"txn_number": null,
"txn_date": null,
"sales_tax_percentage": null,
"item_sales_tax_ref_list_id": null,
"item_sales_tax_ref_full_name": null,
"customer_sales_tax_code_ref_list_id": null,
"customer_sales_tax_code_ref_full_name": null,
"custom_text11": null,
"custom_text12": null,
"custom_text13": null,
"custom_text14": null,
"custom_text15": null,
"custom_text16": null,
"custom_text17": null,
"custom_text18": null,
"custom_text19": null,
"custom_text20": null,
"duration": null,
"ends_at": null,
"created_by": 889900,
"updated_by": null,
"invoice_terms": "Due upon receipt",
"invoice_notes": "",
"estimate_terms": "Due upon receipt",
"estimate_notes": "",
"tax_id": null,
"ship_date": null,
"ship_method_ref_full_name": null,
"description": "Customer need master bathroom tub realigned",
"chosen_days_of_week": [],
"max_recurring_iterator": null,
"recurring_iterator": null,
"detailed_invoice": true,
"service_type_id": null,
"status": "lost",
"invoice_status": "unpaid",
"invoice_date": null,
"invoice_sent_date": null,
"tasks_count": 0,
"won_date": null,
"po_number": "",
"deleted_at": null,
"schedule": null,
"on_hold": null,
"estimate_scheduled_on": null,
"estimate_sent_on": null,
"estimate_viewed_on": null,
"invoice_viewed_on": null,
"lost_date": "2022-05-17T10:04:36-04:00",
"started_on": null,
"canceled_on": null,
"qb_error": null,
"invoice_paid_on": null,
"notification_sent": false,
"total_expenses": 0,
"recurring_date": null,
"job_allocations": {
"allocations": [
{
"id": null,
"amount": "0.0",
"edited": false,
"manual": false,
"allocation_type": "house"
}
],
"include_expenses": true
},
"last_recurring_date": null,
"recurring_ended": null,
"scope_of_work": "",
"custom_fields_migrated": false,
"payment_code": "1a2b3c4d",
"disable_customer_center_payments": false,
"which": "estimate",
"attachments": [ Attachments ],
"customer": {
"id": 6667788,
"customer_number": 71,
"name": "Philip Customer",
"company_name": "Philip Customer",
"service_address": "4368 Pleasantview Lane",
"service_address_2": "Suite 3",
"service_city": "Dorr",
"service_state": "MI",
"service_zip_code": "49323",
"billing_address": "2222 Alger St",
"billing_address_2": "",
"billing_city": "Grand Rapids",
"billing_state": "MI",
"billing_zip_code": "49546",
"notify_via_sms": true,
"notification_phone_number": "+1112223333",
"phone_number": "111-222-3333",
"alt_phone_number": "",
"mobile": "111-222-3333",
"fax": "",
"email_address": "philip@yourdomain.com",
"which_billing_address": "billing",
"special_instructions": "Customer's yard contains landmines",
"company": false,
"primary_contact": {
"contact": {
"id": 4702507,
"customer_id": 6667788,
"account_id": 999,
"first_name": "Philip",
"last_name": "Customer",
"title": "",
"origin": "manual",
"phone1": "111-222-3333",
"phone1_type": "",
"phone2": "",
"phone2_type": "",
"phone3": "",
"phone3_type": "",
"email1": "philip@yourdomain.com",
"email1_type": "",
"email2": "",
"email2_type": "",
"email3": "",
"email3_type": "",
"address": "",
"city": "",
"state": "",
"zip_code": "",
"country": "",
"note": "",
"is_primary": true,
"created_at": "2020-04-07T07:49:58-04:00",
"updated_at": "2020-06-22T12:29:06-04:00",
"deleted_at": null,
"latitude": null,
"longitude": null,
"place_id": null,
"place_id_retrieved_at": null
}
},
"tax_entity": null,
"customer_source": null,
"latitude": 42.7373898,
"longitude": -85.7089006,
"street_latitude": 42.7373898,
"street_longitude": -85.7089006,
"synced?": true,
"custom_field_assignments": [ Custom Fields ],
"parent": null,
"notes": [
{
"id": 12931212,
"account_id": 999,
"created_at": "2021-05-03T18:39:50-04:00",
"created_by": 99775,
"modified_by": 99775,
"noteable_id": 6667788,
"noteable_type": "Customer",
"note": "Customer level note",
"public": null,
"updated_at": "2021-05-03T18:39:50-04:00",
"employee": {
"id": 99775,
"account_id": 999,
"employee_number": 60,
"name": "Johnny Employee",
"admin": false,
"active": true,
"limit_access_to_assignments": false,
"email_address": "johnny@yourdomain.com",
"username": "johnny",
"address": "",
"city": "",
"state": "",
"zip_code": "",
"avatar": "https://someurl/avatar.png"
},
"attachment": null
},
{
"id": 11106312,
"account_id": 999,
"created_at": "2020-04-06T16:38:23-04:00",
"created_by": 889900,
"modified_by": 889900,
"noteable_id": 6667788,
"noteable_type": "Customer",
"note": "second note",
"public": null,
"updated_at": "2020-04-06T16:41:26-04:00",
"employee": {
"id": 889900,
"account_id": 999,
"employee_number": 38,
"name": "Thomas",
"admin": true,
"active": true,
"limit_access_to_assignments": false,
"email_address": "thomas@yourdomain.com",
"username": "thomas",
"address": "",
"city": "",
"state": "",
"zip_code": "",
"avatar": "https://someurl/avatar.png"
},
"attachment": null
},
{
"id": 11106187,
"account_id": 999,
"created_at": "2020-04-06T16:17:35-04:00",
"created_by": 889900,
"modified_by": 889900,
"noteable_id": 6667788,
"noteable_type": "Customer",
"note": "A note",
"public": null,
"updated_at": "2020-04-06T16:17:35-04:00",
"employee": {
"id": 889900,
"account_id": 999,
"employee_number": 38,
"name": "Thomas",
"admin": true,
"active": true,
"limit_access_to_assignments": false,
"email_address": "thomas@yourdomain.com",
"username": "thomas",
"address": "",
"city": "",
"state": "",
"zip_code": "",
"avatar": "https://someurl/avatar.png"
},
"attachment": null
}
],
},
"gross_profit": 0,
"employees": [],
"job_charges": [ Job Charges ],
"custom_field_assignments": [ Custom Fields ],
"recurring_job": null,
"signatures": [ Signatures ],
"tasks": [ Tasks ],
"time_entries": [ Time Entries ],
"assignments": [ Assignments ],
"tax_entity": {
"tax": {
"id": 373737,
"account_id": 999,
"name": "Standard MI Tax",
"rate": "6.0",
"active": true,
"created_at": "2019-09-13T08:01:04-04:00",
"updated_at": "2019-09-13T08:01:04-04:00",
"is_default": true,
"list_id": null,
"edit_sequence": null,
"sales_tax_code_id": null
}
}
"job_type": {
"id": 177484,
"account_id": 999,
"name": "Bathtub Realignment",
"color": "000",
"position": 99,
"active": true,
"created_at": "2020-06-26T11:46:30-04:00",
"updated_at": "2020-06-26T11:46:30-04:00",
"description": "",
"cost": "",
"time": 0,
"text_color": "fff",
"public": false
},
"payments": [ Payments ],
"payment_request": Payment Request ,
"tags": [ Tags ]
}