The number of minutes logged against this record toward completion.

The line 1 portion of the physical address.

The line 2 portion of the physical address.

The city portion of the physical address.

The country portion of the physical address.

The denormalized name of the contact that created this record.

The id of the customer that this record is associated with.

The unix timestamp reflecting when this record was created.

The event end unix timestamp for this record.

The event start unix timestamp for this record.

The unix timestamp reflecting when the status of this record was changed.

The unix timestamp reflecting when this record was updated.

The number of minutes this record is estimated to take to complete.

3rd party data import id, we can use it to link other records from 3rd party

The geo coordinates of the address associated with this record.

The id of the image (avatar) associated with this record.

Whether this record is active(true) or deleted(false).

Whether this record has been archived (true) or not (false).

If multi-location is enabled, the location this record is associated with.

The customer defined template generated number assigned to this record, based off of the record id.

The optional array list of owners for the record.

An object that stores the primary record that is related to this record.

An auto-incrementing number that is assigned to each new record of this type. It is used when generating the number field.

A list of workflow rule ids that have been triggered for this record. Used to prevent recursion.

The denormalized sales_rep of the parent record.

The denormalized sales_rep_name of the parent record.

The state text portion of the physical address.

The workflow status name for this record.

The optional list of subcontractors for the record.

The aggregated number of tasks associated with this record.

The postal code portion of the physical address.

Jobs

The id of the class that this record is associated with. (currently using for referencing qb class)

The name of the class that this record is associated with. (currently using for referencing qb class)

The company name that this contact record is associated with.

Display name used mainly for QB syncing - unique field

The email address associated with this contact.

The fax number associated with this contact.

The first name of the person this contact record is associated with.

The home phone number associated with this contact.

Whether this contact is a subcontractor or not for User.

The last name of the person this contact record is associated with.

The mobile phone number associated with this contact.

The web site associated with this contact.

The work phone number associated with this contact.

Contacts

Payments

Jobnimbus

This request allows you to retrieve all of the contacts within a JobNimbus account.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

<hr />

**Request Parameters**

Request parameters should be passed in the query string

size - number of elements to return (default: 1000)

from - zero based starting point to be used for pagination (default: 0)

sort_field - which field to sort by (default: date_created)

sort_direction = which direction to sort the results (default: 'desc')

fields - limit which fields to include in response (default: all fields will be included)

filter - URL encoded JSON filter object i.e.:

```

{
    "must": [
        {
            "range": {
                "date_created": {
                    "gte": 1459749600,
                    "lte": 1459835940
                }
            }
        }
    ]
}
```

<hr />

**Response**:

Example of a partial response:
```
{
  "recid": 1003,
  "customer": "29a",
  "type": "contact",
  "created_by": "29b",
  "created_by_name": "Sam Burnet",
  "date_created": 1459789425,
  "date_updated": 1460051077,
  "owners": [
    {
      "id": "29b"
    }
  ],
  "location": {
    "id": 1,
    "parent_id": null,
    "name": "Developer Account"
  },
  "first_name": "Bruce",
  "last_name": "Wayne",
  "company": "Wayne Enterprises",
  "description": "Likes to wear costumes...",
  "email": "bruce@batman.com",
  "home_phone": "8882223333",
  "mobile_phone": "",
  "work_phone": "",
  "fax_number": "",
  "address_line1": "123 S. Bat Street",
  "address_line2": null,
  "city": "Heber City",
  "state_text": "UT",
  "country_name": "United States",
  "zip": "84032",
  "website": "www.batman.com",
  "record_type": 1,
  "record_type_name": "Customer",
  "status": 2,
  "status_name": "Inspection",
  "source": 1,
  "source_name": "Referral",
  "sales_rep": "1m1",
  "sales_rep_name": "Sam Burnet",
  "jnid": "1l7",
  "geo": {
    "lat": 0,
    "lon": 0
  },
  ...
}
```

Retrieve ALL Contacts

This request allows you to create a new contact within JobNimbus.

**Notes**:

* First Name, Last Name, First & Last Name, Display_Name, or Company Name are required
* record_type_name is required and should be a workflow name defined in the customers JobNimbus contact workflow settings
* status_name is required and should be a status defined within the record_type_name workflow
* source_name is optional but if provided should be set to one of the lead source names defined in the customer's settings
* Also accepts most of the fields listed in the "GET /contacts" response

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Create a Contact

This request allows you to retrieve the information of a specific contact within JobNimbus.

**Notes**:

Mandatory field(s): jnid

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Retrieve a Contact

This request allows you to update a contact within JobNimbus.

**Notes**:

Mandatory field(s): jnid

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Update a Contact

This request allows you to retrieve all of the jobs within a JobNimbus account.

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

---

  
**Request Parameters**  
  

Request parameters should be passed in the query string

size - number of elements to return (default: 1000)

from - zero based starting point to be used for pagination (default: 0)

sort_field - which field to sort by (default: date_created)

sort_direction = which direction to sort the results (default: 'desc')

fields - limit which fields to include in response (default: all fields will be included)

filter - URL encoded JSON filter object i.e.:

```
{
    "must": [
        {
            "range": {
                "date_created": {
                    "gte": 1459749600,
                    "lte": 1459835940
                }
            }
        }
    ]
}

 ```

**Response**:

Example of a partial response:

```
{  
    "count": 117,
    "results": [       
    {
 "recid": 1001,
 "customer": "3oz",
 "type": "job",
 "created_by": "3p0",
 "created_by_name": "Bot Barton",
 "date_created": 1472567571,
 "date_updated": 1472567572,
 "location": {
  "id": 1,
  "parent_id": null
 },
 "owners": [
  {
   "id": "3p0"
  }
 ],
 "is_active": true,
 "name": "Test job",
 "number": "1001",
 "record_type": 5,
 "record_type_name": "Residential",
 "status": 19,
 "status_name": "Lead",
 "description": null,
 "sales_rep": "3p0",
 "sales_rep_name": "Bob Barton",
 "address_line1": "100 N 52 E",
 "address_line2": "",
 "city": "American Fork",
 "state_text": "UT",
 "country_name": "United States",
 "zip": "84003",
 "jnid": "3pg",
 "geo": {
  "lat": 40.387368,
  "lon": -111.789513
 },
 ...
]
}

 ```

Retrieve ALL Jobs

This request allows you to create a new job within JobNimbus.

**Notes**:

* name is required
* record_type_name is required and should be a workflow name defined in the customers JobNimbus job workflow settings
* status_name is required and should be a status defined within the record_type_name workflow
* source_name is optional but if provided should be set to one of the lead source names defined in the customer's settings
* Also accepts most of the fields listed in the "GET /Jobs" response

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response


Create a Job

This request allows you to retrieve the information of a specific job within JobNimbus.

**Notes**:

Mandatory field(s): jnid

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Retrieve a Job

This request allows you to update a job within JobNimbus.

**Notes**:

* Mandatory field(s): jnid
* Also see required fields in "POST Create a Job"

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Update a Job

This request allows you to retrieve all of the tasks within a JobNimbus account.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:
Example of a partial response:
```
{
    "count": 117,
    "results": [
        {
            "external_id": null,
            "recid": 1145,
            "number": "1145",
            "customer": "jagpt",
            "type": "task",
            "created_by": "jagpu",
            "created_by_name": "Josh Demo",
            "date_created": 1547742470,
            "date_updated": 1547742470,
            "is_active": true,
            "is_archived": false,
            "primary": null,
            "actual_time": 0,
            "estimated_time": 0,
            "title": "Custom Task Type",
            "location": {
                "id": 1
            },
            "description": "New custom task type",
            "record_type": 6,
            "record_type_name": "Custom Task Type",
            "priority": 0,
            "date_start": 1547712000,
            "date_sort": null,
            "date_end": 0,
            "is_completed": false,
            "hide_from_calendarview": false,
            "hide_from_tasklist": false,
            "owners": [
                {
                    "id": "jagpu"
                }
            ],
            "subcontractors": [],
            "related": [
                {
                    "id": "ql1a9",
                    "name": "Martin ROBERTS",
                    "number": "1096",
                    "type": "contact"
                }
            ],
            "jnid": "14yspl",
            "tags": [],
            "rules": []
        },
    ]
}
```

Retrieve ALL Tasks

This request allows you to create a new task within JobNimbus.

**Notes**:

* title and date_start are required
* record_type_name is required and should be a task type name defined in the customer's settings.
* related.id should be set to the contact or job that this task is related to.
* Also accepts most of the fields listed in the "GET /tasks" response

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response


Create a Task

This request allows you to retrieve the information of a specific task within JobNimbus.

**Notes**:

Mandatory field(s): jnid

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Retrieve a Tasks

This request allows you to update a job within JobNimbus.

**Notes**:

* Mandatory field(s): jnid
* Also see required fields in "POST Create a Task"

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Update a Task

This request allows you to retrieve all of the activities within a JobNimbus account.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Request Parameters**

Request parameters should be passed in the query string

size - number of elements to return (default: 1000)

from - zero based starting point to be used for pagination (default: 0)

sort_field - which field to sort by (default: date_created)

sort_direction = which direction to sort the results (default: 'desc')

fields - limit which fields to include in response (default: all fields will be included)

filter - URL encoded JSON filter object i.e.:

```

{
    "must": [
        {
            "range": {
                "date_created": {
                    "gte": 1459749600,
                    "lte": 1459835940
                }
            }
        }
    ]
}
```

<hr />

**Response**:

Example of a partial response:
```
{
  "count": 10,
  "activity": [
  {
    "type": "activity",
    "customer": "7z76o",
    "location": {
        "id": 1
    },
    "primary": {
        "new_status": 13,
        "id": "he2d2",
        "name": "Clark Kent",
        "type": "contact",
        "number": "1017"
    },
    "is_active": true,
    "note": "Contact Created",
    "is_status_change": true,
    "record_type_name": "Contact Created",
    "owners": [],
    "related": [
        {
            "id": "he2d2",
            "type": "contact",
            "name": "Clark Kent",
            "number": "1017"
        }
    ],
    "jnid": "he2d3",
    "created_by": "neo",
    "created_by_name": "Thomas Anderson",
    "date_created": 1512763337,
    "date_updated": 1512763337,
    "is_archived": false,
    "is_editable": false
  },
  ...
]
```

Retrieve ALL Activities

This request allows you to create a new Activity within JobNimbus.

**Notes**:

* note, record_type_name and primary.id should be included.
* Also accepts most of the fields listed in the "GET /activities" response

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response


Create an Activity

This request allows you to retrieve the information of a specific activity within JobNimbus.

**Notes**:

Mandatory field(s): jnid

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

Retrieve an Activity

This request allows you to retrieve the information of all of the file attachments within a JobNimbus account.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

Example of a partial response:
```
{
    "count": 165,
    "files": [
        {
            "customer": "jagpt",
            "type": "attachment",
            "created_by": "jagpu",
            "created_by_name": "Josh Demo",
            "is_active": true,
            "filename": "Screen Shot 2018-06-26 at 8.39.48 PM.png",
            "content_type": "image/png",
            "size": 555204,
            "jnid": "jsy16hg9ztze7cxx",
            "date_created": 1551926855,
            "date_updated": 1551926859,
            "is_private": false,
            "related": [
                {
                    "id": "scpci",
                    "type": "contact",
                    "name": "Jimmy Rivera III"
                }
            ],
            "primary": {
                "id": "scpci",
                "type": "contact",
                "number": "1164",
                "name": "Jimmy Rivera III"
            },
            "owners": [
                {
                    "id": "jagpu"
                }
            ],
            "sales_rep": "jagpu",
            "is_archived": false,
            "record_type": 2,
            "record_type_name": "Photo"
        }
    ]
}
```

Retrieve List of File Attachments

This request allows you to create a new File attachment within JobNimbus.

**Notes**:

*Data attribute should be base64 encoded, ie. btoa('This is my document text.')

Type: 
* 1=Document 
* 2=Photo
* 3=Email Attachment
* 4=naturalForms
* 5=Invoice
* 6=Eagleview
* 7=Accurence
* 8=Credit Memo

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

```
{
    "count": 165,
    "files": [
        {
            "customer": "jagpt",
            "type": "attachment",
            "created_by": "jagpu",
            "created_by_name": "Josh Demo",
            "is_active": true,
            "filename": "Screen Shot 2018-06-26 at 8.39.48 PM.png",
            "content_type": "image/png",
            "size": 555204,
            "jnid": "jsy16hg9ztze7cxx",
            "date_created": 1551926855,
            "date_updated": 1551926859,
            "is_private": false,
            "related": [
                {
                    "id": "scpci",
                    "type": "contact",
                    "name": "Jimmy Rivera III"
                }
            ],
            "primary": {
                "id": "scpci",
                "type": "contact",
                "number": "1164",
                "name": "Jimmy Rivera III"
            },
            "owners": [
                {
                    "id": "jagpu"
                }
            ],
            "sales_rep": "jagpu",
            "is_archived": false,
            "record_type": 2,
            "record_type_name": "Photo"
        }
    ]
}
```

Create a File

This request allows you to create a new File attachment within JobNimbus.

**Notes**:

* Data attribute should be base64 encoded, ie. btoa('This is my document text.')

* Type: 
 * 1=Document 
 * 2=Photo
 * 3=Email Attachment
 * 4=naturalForms
 * 5=Invoice
 * 6=Eagleview
 * 7=Accurence
 * 8=Credit Memo

* related[] should be the jnid of the contact or job that this file should be attached to
* type should be set to a valid file type as defined in the JobNimbus customer settings. Usually this can be set to 'Photo'
* description should be set to a photo caption/description
* name should be set to the file name. If not supplied, the file name will be extracted from the url
* url should be set to the publicly accessable url of the image

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response
* A json response body will include an 'id' field. This should probably be associated with the file in the remote database in case we decide to implement the ability to upload image revisions

Create a File from URL

This request allows you to retrieve a file attachments within a JobNimbus account.

**Notes**:

Mandatory field(s): jnid

**Response Codes**:

- HTTP Status 200 = success.
    
- Anything other status code = failure and will include an error message in the response.

Retrieve a File Attachment

This request allows you to retrieve all of the products within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Retrieve ALL Products

This request allows you to create a product within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

---

**Additional Information:**

- Only products with names less than 32 characters can be synced with QuickBooks. Even if the account is not linked with QuickBooks it's often good to keep product names within that range in case the account will be linked with Quickbooks later.
    
- The `item_type` property in the JSON body should have the value of `material`, `labor`, or `labor+material`
    
- `item_type` will always be `material` if labor and material is not enabled in the account. If labor and material is enabled in the account then the `item_type` will be `material` if there is only material cost/price, `labor` if there is only labor cost/price, and `labor+material` if there is both material cost/price **and** labor cost/price.

Create a Product

This request allows you to retrieve a specific product within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Retrieve a Product

This request allows you to update a specific product within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

---

**Additional Information:**

- Only products with names less than 32 characters can be synced with QuickBooks. Even if the account is not linked with QuickBooks it's often good to keep product names within that range in case the account will be linked with Quickbooks later.
    
- The `item_type` property in the JSON body should have the value of `material`, `labor`, or `labor+material`
    
- `item_type` will always be `material` if labor and material is not enabled in the account. If labor and material is enabled in the account then the `item_type` will be `material` if there is only material cost/price, `labor` if there is only labor cost/price, and `labor+material` if there is both material cost/price **and** labor cost/price.

Update a Product

Retrieve ALL MaterialOrders

Create a MaterialOrder

This request allows you to retrieve a specific material order within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Retrieve a MaterialOrder

Update a MaterialOrder

Delete a MaterialOrder

This request allows you to retrieve all of the work orders within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

---

**Query Parameters:**

- `from`: Starting index for pagination (e.g., 10)
    
- `size`: Number of results to return (e.g., 5)
    

---

**Additional details:**

- `size` equals 1,000 by default if not included in the request.
    
- The maximum value for `size` is 10,000.
    
- The `count` property in the response body refers to the number of work orders in the account, not the number of work orders returned in the request.

Retrieve ALL WorkOrders

This request allows you to create a work order within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Create a WorkOrder

This request allows you to update a specific work order within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Update a WorkOrder

This request allows you to retrieve a specific work order within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Retrieve a WorkOrder

### Retrieve Estimates

This endpoint allows you to retrieve all estimates within a JobNimbus account.

---

**Request Parameters:**

- `from` (optional): Starting index for pagination (e.g., 10)
    
- `size` (optional): Number of results to return (e.g., 5)
    

---

**Response:**

The response will contain an array of estimates with the following fields:

- `attachment_id`: ID of the attachment
    
- `cost`: Total cost of the estimate
    
- `created_by`: ID of the user who created the estimate
    
- `created_by_name`: Name of the user who created the estimate
    
- `customer`: ID of the customer associated with the estimate
    
- `date_created`: Timestamp of the creation date
    
- `date_estimate`: Timestamp of the estimate date
    
- `date_sign_requested`: Timestamp of the sign request date
    
- `date_signed`: Timestamp of the sign date
    
- `date_status_change`: Timestamp of the status change date
    
- `date_updated`: Timestamp of the last update
    
- `esigned`: Boolean indicating if the estimate is e-signed
    
- `guid`: Unique identifier of the estimate
    
- `is_active`: Boolean indicating if the estimate is active
    
- `is_archived`: Boolean indicating if the estimate is archived
    
- `items`: Array of items within the estimate, each containing amount, cost, item type, name, price, quantity, and unit of measure
    
- `jnid`: ID of the estimate
    
- `location`: Object containing the ID of the location
    
- `margin`: Margin of the estimate
    
- `number`: Estimate number
    
- `owners`: Array of owners, each containing the ID
    
- `recid`: Record ID
    
- `related`: Array of related entities, each containing ID, name, number, and type
    
- `sales_rep`: ID of the sales representative
    
- `sales_rep_name`: Name of the sales representative
    
- `sections`: Array of sections
    
- `signature_status`: Status of the signature
    
- `source`: Source of the estimate
    
- `status`: Status code of the estimate
    
- `status_name`: Name of the status
    
- `subtotal`: Subtotal of the estimate
    
- `tax`: Tax amount
    
- `template_id`: ID of the template used for the estimate
    
- `total`: Total amount of the estimate
    
- `type`: always 'estimate'
    

Example of a partial response:

``` json
{
    "count": 1000,
    "results": [
        {
            "attachment_id": "attachmentjnid",
            "cost": 10000,
            "created_by": "system_qbo",
            "created_by_name": "QuickBooks",
            "customer": "customerjnid",
            "date_created": 1600000000,
            "date_estimate": 1600000000,
            "date_sign_requested": 1600000000,
            "date_signed": 1600000000,
            "date_status_change": 1600000000,
            "date_updated": 1600000000,
            "esigned": false,
            "guid": "12345678-ABCD-1234-EFGH-1234567890AB",
            "is_active": true,
            "is_archived": true,
            "items": [
                {
                    "amount": 10000,
                    "cost": 10000,
                    "item_type": "material",
                    "name": "Service",
                    "price": 10000,
                    "quantity": 1,
                    "uom": "Items"
                }
            ],
            "jnid": "Estimate_ID",
            "location": {
                "id": 1
            },
            "margin": 0,
            "number": "EST-001",
            "owners": [
                {
                    "id": "OWNER_ID_1"
                }
            ],
            "recid": 1000,
            "related": [
                {
                    "id": "JOB_ID_1",
                    "name": "Sample Project / SAMPLE-ID",
                    "number": "1000",
                    "type": "job"
                },
                {
                    "id": "CONTACT_ID_1",
                    "name": "John Doe (SAMPLE-ID)",
                    "number": "1001",
                    "type": "contact"
                }
            ],
            "sales_rep": "salesrepjnid",
            "sales_rep_name": "Jane Smith",
            "sections": [],
            "status": 4,
            "status_name": "Closed",
            "subtotal": 10000,
            "tax": 0,
            "template_id": "templatejnid",
            "total": 10000,
            "type": "estimate"
        }
    ]
}

 ```

**Response Codes**:

- HTTP Status 200: Success
    
- Any other status code: Failure with an error message in the response

Retrieve ALL Estimates

This request allows you to create a new estimate within JobNimbus.

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Create an Estimate

### Update Existing Estimate

This endpoint allows you to update an existing Estimate within JobNimbus.

#### Request Body

- `type`: 'estimate'
    
- `date_created`: Timestamp of the creation date
    
- `date_updated`: Timestamp of the last update date
    
- `date_estimate`: Timestamp of the estimate date
    
- `jnid`: Unique identifier for the estimate
    
- `number`: estimate number
    
- `is_active`: Indicates if the estimate is active
    
- `status`: Status of the estimate
    
- `internal_note`: Internal note for the estimate
    
- `related`: Array of related entities with their IDs and types
    
- `items`: Array of items included in the estimate with details like name, description, quantity, price, etc.
    

#### Response

The response of this request can be documented as a JSON schema. Here is a partial example of the response:

``` json
{
    "type": "estimate",
    "external_id": null,
    "guid": "12345678-ABCD-1234-EFGH-1234567890AB",
    "merged": null,
    "class_id": null,
    "class_name": null,
    "supplier": null,
    "recid": 1000,
    "attachment_id": "ATTACHMENT_ID_123",
    "customer": "CUSTOMER_ID_123",
    "created_by": "system_qbo",
    "created_by_name": "QuickBooks",
    "date_created": 1600000000,
    "date_updated": 1600000001,
    "esigned": false,
    "is_active": true,
    "is_archived": true,
    "related": [
        {
            "id": "JOB_ID_123",
            "name": "John Doe / PROJECT-123",
            "number": "1000",
            "type": "job",
            "email": null,
            "subject": null
        },
        {
            "id": "CONTACT_ID_123",
            "name": "John Doe (CLIENT-123)",
            "number": "2000",
            "type": "contact",
            "email": null,
            "subject": null
        }
    ],
    "status": 4,
    "status_name": "Closed",
    "number": "INV-001",
    "location": {
        "id": 1
    },
    "subtotal": 10000,
    "margin": 0,
    "tax": 0,
    "total": 10000,
    "cost": 10000,
    "terms": null,
    "note": "",
    "date_estimate": 1600000003,
    "date_status_change": 1600000004,
    "items": [
        {
            "quickbooksId": "1",
            "showGroupTotal": null,
            "addMarkup": null,
            "photos": [],
            "jnid": "ITEM_ID_123",
            "name": "Service",
            "uom": "Items",
            "item_type": "material",
            "description": "John Doe / PROJECT-123 / SERVICE",
            "quantity": 1,
            "price": 10000,
            "preSurchargePrice": null,
            "cost": 10000,
            "amount": 10000,
            "tax_couch_id": null,
            "tax_name": null,
            "tax_rate": 0,
            "labor": {
                "quickbooksId": null,
                "price": 0,
                "preSurchargePrice": null,
                "cost": 0,
                "addMarkup": null,
                "amount": 0,
                "tax_couch_id": null,
                "tax_name": null,
                "tax_rate": 0
            },
            "sku": null,
            "color": null,
            "category": null
        }
    ],
    "sections": [],
    "owners": [
        {
            "id": "OWNER_ID_123"
        }
    ],
    "sales_rep": "SALES_REP_ID_123",
    "sales_rep_name": "Jane Smith",
    "jnid": "INVOICE_ID_123",
    "internal_note": "",
    "template_id": "TEMPLATE_ID_123"
}

 ```

**Response JSON Schema:**

``` json
{
    "type": "object",
    "properties": {
        "type": {"type": "string"},
        "external_id": {"type": ["string", "null"]},
        "guid": {"type": "string"},
        "merged": {"type": ["string", "null"]},
        "class_id": {"type": ["string", "null"]},
        "class_name": {"type": ["string", "null"]},
        "supplier": {"type": ["string", "null"]},
        "recid": {"type": "integer"},
        "attachment_id": {"type": "string"},
        "customer": {"type": "string"},
        "created_by": {"type": "string"},
        "created_by_name": {"type": "string"},
        "date_created": {"type": "integer"},
        "date_updated": {"type": "integer"},
        "esigned": {"type": "boolean"},
        "is_active": {"type": "boolean"},
        "is_archived": {"type": "boolean"},
        "related": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "id": {"type": "string"},
                    "name": {"type": "string"},
                    "number": {"type": "string"},
                    "type": {"type": "string"},
                    "email": {"type": ["string", "null"]},
                    "subject": {"type": ["string", "null"]}
                }
            }
        },
        "status": {"type": "integer"},
        "status_name": {"type": "string"},
        "number": {"type": "string"},
        "location": {
            "type": "object",
            "properties": {
                "id": {"type": "integer"}
            }
        },
        "subtotal": {"type": "integer"},
        "margin": {"type": "integer"},
        "tax": {"type": "integer"},
        "total": {"type": "integer"},
        "cost": {"type": "integer"},
        "note": {"type": "string"},
        "date_estimate": {"type": "integer"},
        "date_status_change": {"type": "integer"},
        "items": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "quickbooksId": {"type": ["string", "null"]},
                    "showGroupTotal": {"type": ["string", "null"]},
                    "addMarkup": {"type": ["string", "null"]},
                    "photos": {"type": "array"},
                    "jnid": {"type": "string"},
                    "name": {"type": "string"},
                    "uom": {"type": "string"},
                    "item_type": {"type": "string"},
                    "description": {"type": "string"},
                    "quantity": {"type": "integer"},
                    "price": {"type": "integer"},
                    "preSurchargePrice": {"type": ["string", "null"]},
                    "cost": {"type": "integer"},
                    "amount": {"type": "integer"},
                    "tax_couch_id": {"type": ["string", "null"]},
                    "tax_name": {"type": ["string", "null"]},
                    "tax_rate": {"type": "integer"},
                    "labor": {
                        "type": "object",
                        "properties": {
                            "quickbooksId": {"type": ["string", "null"]},
                            "price": {"type": "integer"},
                            "preSurchargePrice": {"type": ["string", "null"]},
                            "cost": {"type": "integer"},
                            "addMarkup": {"type": ["string", "null"]},
                            "amount": {"type": "integer"},
                            "tax_couch_id": {"type": ["string", "null"]},
                            "tax_name": {"type": ["string", "null"]},
                            "tax_rate": {"type": "integer"}
                        }
                    },
                    "sku": {"type": ["string", "null"]},
                    "color": {"type": ["string", "null"]},
                    "category": {"type": ["string", "null"]}
                }
            }
        },
        "sections": {"type": "array"},
        "owners": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "id": {"type": "string"}
                }
            }
        },
        "sales_rep": {"type": "string"},
        "sales_rep_name": {"type": "string"},
        "jnid": {"type": "string"},
        "internal_note": {"type": "string"},
        "template_id": {"type": "string"},
        "version": {"type": ["string", "null"]},
        "duplicate_from_id": {"type": ["string", "null"]}
    }
}

 ```

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Update an Estimate

### Retrieve Estimate

This endpoint allows you to retrieve a single estimate within a JobNimbus account by providing the `estimateID` in the URL.

#### Request Body

This is a GET request and does not require a request body.

#### Response Body

The response will contain the details of the retrieved estimate, including the `type`, `guid`, `source`, `recid`, `attachment_id`, `customer`, `created_by`, `created_by_name`, `date_sign_requested`, `date_signed`, `date_created`, `date_updated`, `is_active`, `signature_status`, `related` (with id, name, number, type, email, and subject), `owners` (with id), `sales_rep`, `status`, `status_name`, `number`, `cost`, `margin`, `subtotal`, `tax`, `total`, `location` (with id), `date_estimate`, `date_status_change`, `items` (with jnid, name, description, quantity, cost, price, uom, sku, category, item_type, and amount), `sections` (with index, name, group, and showGroupTotal), `jnid`, `template_id`, `is_archived`, `esigned`, and `sales_rep_name`.

Example of a partial response:

``` json
{
    "type": "estimate",
    "guid": "12345678-ABCD-1234-EFGH-1234567890AB",
    "recid": 1000,
    "attachment_id": "ATTACHMENT_ID_123",
    "customer": "CUSTOMER_ID_123",
    "created_by": "system_qbo",
    "created_by_name": "QuickBooks",
    "date_created": 1600000000,
    "date_updated": 1600000001,
    "esigned": false,
    "is_active": true,
    "is_archived": true,
    "related": [
        {
            "id": "JOB_ID_123",
            "name": "John Doe / PROJECT-123",
            "number": "1000",
            "type": "job",
            "email": null,
            "subject": null
        },
        {
            "id": "CONTACT_ID_123",
            "name": "John Doe (CLIENT-123)",
            "number": "2000",
            "type": "contact",
            "email": null,
            "subject": null
        }
    ],
    "status": 4,
    "status_name": "Closed",
    "number": "EST-001",
    "location": {
        "id": 1
    },
    "subtotal": 10000,
    "margin": 0,
    "tax": 0,
    "total": 10000,
    "cost": 10000,
    "terms": null,
    "note": "",
    "date_estimate": 1600000003,
    "date_status_change": 1600000004,
    "items": [
        {
            "jnid": "ITEM_ID_123",
            "name": "Service",
            "uom": "Items",
            "item_type": "material",
            "description": "John Doe / PROJECT-123 / SERVICE",
            "quantity": 1,
            "price": 10000,
            "cost": 10000,
            "amount": 10000
        }
    ],
    "sections": [],
    "owners": [
        {
            "id": "OWNER_ID_123"
        }
    ],
    "sales_rep": "SALES_REP_ID_123",
    "sales_rep_name": "Jane Smith",
    "jnid": "INVOICE_ID_123",
    "internal_note": "",
    "template_id": "TEMPLATE_ID_123",
    "first_payment_date": 1600000006
}

 ```

Retrieve an Estimate

This request allows you to retrieve all of the invoices within a JobNimbus account.

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

---

**Query Parameters:**

- `from`: Starting index for pagination (e.g., 10)
    
- `size`: Number of results to return (e.g., 5)
    

---

**Response**:

Example of a partial response:

``` json
{
    "count": 1000,
    "results": [
        {
            "attachment_id": "attachmentjnid",
            "class_id": null,
            "class_name": null,
            "cost": 10000,
            "created_by": "system_qbo",
            "created_by_name": "QuickBooks",
            "customer": "customerjnid",
            "date_created": 1600000000,
            "date_due": 1600000001,
            "date_invoice": 1600000002,
            "date_paid_in_full": 1600000003,
            "date_status_change": 1600000004,
            "date_updated": 1600000005,
            "due": 0,
            "duplicate_from_id": null,
            "esigned": false,
            "external_id": null,
            "first_payment_date": 1600000006,
            "guid": "12345678-ABCD-1234-EFGH-1234567890AB",
            "internal_note": "",
            "is_active": true,
            "is_archived": true,
            "items": [
                {
                    "amount": 10000,
                    "cost": 10000,
                    "description": "Sample Project / SAMPLE-ID / SERVICE",
                    "item_type": "material",
                    "jnid": "ITEM_ID_1",
                    "labor": {
                        "amount": 0,
                        "cost": 0,
                        "price": 0,
                        "tax_rate": 0
                    },
                    "name": "Service",
                    "price": 10000,
                    "quantity": 1,
                    "quickbooksId": "1",
                    "tax_rate": 0,
                    "uom": "Items"
                }
            ],
            "jnid": "INVOICE_ID_1",
            "location": {
                "id": 1
            },
            "margin": 0,
            "note": "",
            "number": "INV-001",
            "owners": [
                {
                    "id": "OWNER_ID_1"
                }
            ],
            "payments": [],
            "recid": 1000,
            "related": [
                {
                    "id": "JOB_ID_1",
                    "name": "Sample Project / SAMPLE-ID",
                    "number": "1000",
                    "type": "job"
                },
                {
                    "id": "CONTACT_ID_1",
                    "name": "John Doe (SAMPLE-ID)",
                    "number": "1001",
                    "type": "contact"
                }
            ],
            "sales_rep": "salesrepjnid",
            "sales_rep_name": "Jane Smith",
            "sections": [],
            "status": 4,
            "status_name": "Closed",
            "subtotal": 10000,
            "supplier": null,
            "tax": 0,
            "template_id": "templatejnid",
            "terms": null,
            "total": 10000,
            "total_paid": 10000,
            "type": "invoice",
            "version": null
        }
    ]
}

 ```

Retrieve ALL Invoices

This request allows you to create a new invoice within JobNimbus.

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Create an Invoice

This request allows you to retrieve a single invoice within a JobNimbus account.

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

---

**Response**:

Example of a partial response:

``` json
{
    "type": "invoice",
    "external_id": null,
    "guid": "12345678-ABCD-1234-EFGH-1234567890AB",
    "merged": null,
    "class_id": null,
    "class_name": null,
    "supplier": null,
    "recid": 1000,
    "attachment_id": "ATTACHMENT_ID_123",
    "customer": "CUSTOMER_ID_123",
    "created_by": "system_qbo",
    "created_by_name": "QuickBooks",
    "date_created": 1600000000,
    "date_updated": 1600000001,
    "esigned": false,
    "is_active": true,
    "is_archived": true,
    "related": [
        {
            "id": "JOB_ID_123",
            "name": "John Doe / PROJECT-123",
            "number": "1000",
            "type": "job",
            "email": null,
            "subject": null
        },
        {
            "id": "CONTACT_ID_123",
            "name": "John Doe (CLIENT-123)",
            "number": "2000",
            "type": "contact",
            "email": null,
            "subject": null
        }
    ],
    "status": 4,
    "status_name": "Closed",
    "number": "INV-001",
    "location": {
        "id": 1
    },
    "subtotal": 10000,
    "margin": 0,
    "tax": 0,
    "total": 10000,
    "cost": 10000,
    "total_paid": 10000,
    "due": 0,
    "terms": null,
    "note": "",
    "date_due": 1600000002,
    "date_invoice": 1600000003,
    "date_status_change": 1600000004,
    "date_paid_in_full": 1600000005,
    "items": [
        {
            "quickbooksId": "1",
            "showGroupTotal": null,
            "addMarkup": null,
            "addMarkupIsExcluded": null,
            "photos": [],
            "jnid": "ITEM_ID_123",
            "name": "Service",
            "uom": "Items",
            "item_type": "material",
            "description": "John Doe / PROJECT-123 / SERVICE",
            "quantity": 1,
            "price": 10000,
            "preSurchargePrice": null,
            "cost": 10000,
            "amount": 10000,
            "tax_couch_id": null,
            "tax_name": null,
            "tax_rate": 0,
            "labor": {
                "quickbooksId": null,
                "price": 0,
                "preSurchargePrice": null,
                "cost": 0,
                "addMarkup": null,
                "addMarkupIsExcluded": null,
                "amount": 0,
                "tax_couch_id": null,
                "tax_name": null,
                "tax_rate": 0
            },
            "sku": null,
            "color": null,
            "category": null
        }
    ],
    "sections": [],
    "payments": [],
    "owners": [
        {
            "id": "OWNER_ID_123"
        }
    ],
    "sales_rep": "SALES_REP_ID_123",
    "sales_rep_name": "Jane Smith",
    "jnid": "INVOICE_ID_123",
    "internal_note": "",
    "template_id": "TEMPLATE_ID_123",
    "first_payment_date": 1600000006,
    "version": null,
    "duplicate_from_id": null
}

 ```

Retrieve an Invoice

This request allows you to update an existing invoice within JobNimbus.

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

---

**Response**:

Example of a partial response:

``` json
{
    "type": "invoice",
    "external_id": null,
    "guid": "12345678-ABCD-1234-EFGH-1234567890AB",
    "merged": null,
    "class_id": null,
    "class_name": null,
    "supplier": null,
    "recid": 1000,
    "attachment_id": "ATTACHMENT_ID_123",
    "customer": "CUSTOMER_ID_123",
    "created_by": "system_qbo",
    "created_by_name": "QuickBooks",
    "date_created": 1600000000,
    "date_updated": 1600000001,
    "esigned": false,
    "is_active": true,
    "is_archived": true,
    "related": [
        {
            "id": "JOB_ID_123",
            "name": "John Doe / PROJECT-123",
            "number": "1000",
            "type": "job",
            "email": null,
            "subject": null
        },
        {
            "id": "CONTACT_ID_123",
            "name": "John Doe (CLIENT-123)",
            "number": "2000",
            "type": "contact",
            "email": null,
            "subject": null
        }
    ],
    "status": 4,
    "status_name": "Closed",
    "number": "INV-001",
    "location": {
        "id": 1
    },
    "subtotal": 10000,
    "margin": 0,
    "tax": 0,
    "total": 10000,
    "cost": 10000,
    "total_paid": 10000,
    "due": 0,
    "terms": null,
    "note": "",
    "date_due": 1600000002,
    "date_invoice": 1600000003,
    "date_status_change": 1600000004,
    "date_paid_in_full": 1600000005,
    "items": [
        {
            "quickbooksId": "1",
            "showGroupTotal": null,
            "addMarkup": null,
            "addMarkupIsExcluded": null,
            "photos": [],
            "jnid": "ITEM_ID_123",
            "name": "Service",
            "uom": "Items",
            "item_type": "material",
            "description": "John Doe / PROJECT-123 / SERVICE",
            "quantity": 1,
            "price": 10000,
            "preSurchargePrice": null,
            "cost": 10000,
            "amount": 10000,
            "tax_couch_id": null,
            "tax_name": null,
            "tax_rate": 0,
            "labor": {
                "quickbooksId": null,
                "price": 0,
                "preSurchargePrice": null,
                "cost": 0,
                "addMarkup": null,
                "addMarkupIsExcluded": null,
                "amount": 0,
                "tax_couch_id": null,
                "tax_name": null,
                "tax_rate": 0
            },
            "sku": null,
            "color": null,
            "category": null
        }
    ],
    "sections": [],
    "payments": [],
    "owners": [
        {
            "id": "OWNER_ID_123"
        }
    ],
    "sales_rep": "SALES_REP_ID_123",
    "sales_rep_name": "Jane Smith",
    "jnid": "INVOICE_ID_123",
    "internal_note": "",
    "template_id": "TEMPLATE_ID_123",
    "first_payment_date": 1600000006,
    "version": null,
    "duplicate_from_id": null
}

 ```

Update an Invoice

This request allows you to retrieve all of the work orders within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response

Retrieve ALL Payments

This request allows you to create a payment within a JobNimbus account.

---

**Response Codes**:

- HTTP Status 200 = success
    
- HTTP Status 500 = failure (most likely missing a required field)
    
- Anything other status code = failure and will include an error message in the response

Create a Payment

Retrieve ALL Budgets

This request allows you to retrieve the configuration of a JobNimbus account's settings.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

* If a field is passed then the API will return a value in that field from the customer object.
* If a field is null then see an example of the partial response below:

```
{
  "workflows": [
    {
      "id": 1,
      "order": 1,
      "object_type": "contact",
      "name": "Customer",
      "is_sub_contractor": false,
      "is_supplier": false,
      "is_active": true,
      "can_access_by_all": false,
      "is_vendor": false,
      "icon": null,
    "status": [
        {
          "id": 1,
          "name": "Lead",
          "is_lead": true,
          "is_closed": false,
          "is_active": true,
          "is_archived": false,
          "send_to_quickbooks": false,
          "force_mobile_sync": false,
          "order": 1,
          "profile_ids": [
            0
          ]
        },....]      
    },
    .....
  ],
  "fileTypes": [
    {
      "FileTypeId": 1,
      "TypeName": "Document",
      "IsActive": true
    },
  .....
  ],
  "taskTypes": [
    {
      "TaskTypeId": 1,
      "TypeName": "Task",
      "DefaultName": "Task",
      "Icon": "",
      "HideFromTaskList": false,
      "HideFromCalendarView": false,
      "IsActive": true
    },
 .....
  ],
  "activityTypes": [
    {
      "ActivityTypeId": 1,
      "TypeName": "Note",
      "ShowInJobShare": false,
      "IsActive": true
    },
  .....
  ],
  "sources": [
    {
      "JobSourceId": 1,
      "SourceName": "Referral",
      "IsActive": true
    },
     .....
  ]
}
```

Retrieve Account Settings

This request allows you to retrieve a list of an account's JobNimbus users.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

Example of a partial response:

```
{
    "users": [
        {
            "first_name": "fname",
            "last_name": "lname",
            "image_url": "",
            "id": "abcdid", // this is user's contact jnid
            "calendar_color": "#2ECC71",
            "email": "abc@jobnimbus.com",
            "is_active": true // whether user is active or disabled
        },....
   "date_updated": 1519413931 // last time when this document updated (user added, updated, modified)
}
```

Retrieve Users or Team Members

This request allows you to retrieve a list of Units of Measurement.

**Response Codes**:

- HTTP Status 200 = success
    
- Anything other status code = failure and will include an error message in the response
    

**Response**:

Example of a partial response:

```
[
"SQ",
"UOM1",...
]

 ```

Retrieve UoMs

This request allows you to create a new workflow within a Jobnimbus account. Note: The token used must have an access profile level with access to the account settings page.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

If a workflow already exists, then the API endpoint will return with a response with the status for that workflow.
If the workflow didn't exist, then the API endpoint will return a response similar to the example, below:

```
{
      "id": 1,
      "order": 1,
      "object_type": "contact",
      "name": "Customer",
      "is_sub_contractor": false,
      "is_supplier": false,
      "is_active": true,
      "can_access_by_all": false,
      "is_vendor": false,
      "icon": null,
    "status": [
        {
          "id": 1,
          "name": "Lead",
          "is_lead": true,
          "is_closed": false,
          "is_active": true,
          "is_archived": false,
          "send_to_quickbooks": false,
          "force_mobile_sync": false,
          "order": 1,
          "profile_ids": [
            0
          ]
        },....]      
    },
    .....
  ]
}
```

Create a Workflow

This request allows you to create a new status within a workflow within a Jobnimbus account. Note: The token used must have an access profile level with access to the account settings page.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

If a workflow already exists, then the API endpoint will return with a response with the status for that workflow.
If the workflow didn't exist, then the API endpoint will return a response similar to the example, below:

```
{
  "id": 1,
  "name": "Lead",
  "is_lead": true,
  "is_closed": false,
  "is_active": true,
  "is_archived": false,
  "send_to_quickbooks": false,
  "force_mobile_sync": false,
  "order": 1,
  "profile_ids": [
    0
  ]
}
```

Create a Status within a Workflow

Create a Lead Source

This request allows you to create a new custom field within a Jobnimbus account. Note: The token used must have an access profile level with access to the account settings page.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

If a custom field with that name already exists, then the API endpoint will return with a response with the status for that custom field.
If the custom field didn't exist, then the API endpoint will return a response similar to the example, below:

```
{
    "title": "new2",
    "type": "string",
    "visible": true,
    "is_currency": false,
    "is_ddn": true,
    "is_required": false,
    "options": [
        "test",
        "test1"
    ],
    "field": "cf_string_7"
}
```

Create a Custom Field

This request allows you to create a new file type within a Jobnimbus account. Note: The token used must have an access profile level with access to the account settings page.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

If a file type with that name already exists, then the API endpoint will return with a response with the status for that file type.
If the file type didn't exist, then the API endpoint will return a response similar to the example, below:

```
{
    "FileTypeId": 895,
    "TypeName": "Document",
    "IsActive": true
}
```

Create a File Type

This request allows you to create a new task type within a Jobnimbus account. Note: The token used must have an access profile level with access to the account settings page.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

If a task type with that name already exists, then the API endpoint will return with a response with the status for that task type.
If the task type didn't exist, then the API endpoint will return a response similar to the example, below:

```
{
    "TaskTypeId": 1469,
    "TypeName": "Task",
    "DefaultName": "Task",
    "Icon": null,
    "HideFromTaskList": false,
    "HideFromCalendarView": false,
    "IsActive": true
}
```

Create a Task Type

This request allows you to create a new activity type within a Jobnimbus account. Note: The token used must have an access profile level with access to the account settings page.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

If an activity type with that name already exists, then the API endpoint will return with a response with the status for that activity type.
If the activity type didn't exist, then the API endpoint will return a response similar to the example, below:

```
{
    "ActivityTypeId": 1518,
    "TypeName": "Note",
    "ShowInJobShare": true,
    "IsActive": true
}
```

Create an Activity Type

This request allows you to create a new location within a Jobnimbus account. Note: The token used must have an access profile level with access to the account settings page.

**Response Codes**:

* HTTP Status 200 = success
* Anything other status code = failure and will include an error message in the response

**Response**:

If a location  with that name already exists, then the API endpoint will return with a response with the status for that location.
If the location didn't exist, then the API endpoint will return a response similar to the example, below:

```
Eg1:
{
    "id": 4,
    "name": "Location Name",
    "is_active": true,
    "address_line1": "address1",
    "address_line2": "address2",
    "code": "HH",
    "city": "American Fork",
    "zip": "84004",
    "phone": "999-999-9999"
}
Eg2:
{
    "id": 1,
    "name": "HungryHead",
    "code": "HH",
    "address_line1": "102, sapetrshi apt",
    "address_line2": "sagrampura",
    "city": "Surat",
    "state_text": "Gujarat",
    "country_name": "India",
    "zip": "392002",
    "phone": "9033204250",
    "logo_id": "j5m9a0agbjnt3xvv",
    "header_color": "#c1cfd8",
    "is_active": true,
    "calendar": {
        "weekends": true,
        "start_day": 0,
        "business_hours": {
            "start": 1502649000,
            "end": 1502734500
        }
    }
}
```

Create a Location

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Freshsales

Keap

Mailchimp

SugarCRM

Outreach

Xero

ActiveCampaign

Capsule CRM

Salesloft

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

Sage Accounting

Attio

Copper

Intercom

Zoho Books

Front

Close

NetSuite

Freshdesk

AWeber

Affinity

Apollo.io

GoHighLevel

Exact Online

Mautic

Ontraport

# Continuous Import of Contacts to Your App

This scenario enables your application to continuously sync Contacts from any external application to your app's API. It handles the initial import of Contacts and keeps them synchronized when a Contact is created, updated, or deleted in the external application.

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Contacts to my App

Import Contacts and receive created/updated or deleted events

# Get all Contacts

This scenario enables your application to get a complete list of Contacts from any external application to your app's API in the same way. 

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Contacts along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Contacts page by page.


Get all Contacts

Imports all Contacts from any external application to your App.

Woosender

# Enrich newly created Contacts

This scenario enables your application to enrich with the new data any newly createad Contacts in external application. 

It handles subscription to the created events and Contact fields mapping from your application's schema to the application-specific schema.

## How It Works
1. **Configuration**:
   - You will setup the schema of fields that you wish to enrich Contact with and configure mapping to our default model.
   - If needed - your customer can customize this mapping based on their specific setup or even custom fields

2. **Enable receiving of Contact created events**:
   - Enable subscription via a single API or SDK call to continuously receive created events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

2. **React to created Contacts**:
   - Integration.app flow will be launched when new Contact is created
   - It will send existing data to your app API, so you can decide how to enrich. Your API will return enriched data.
   - Integration.app will send enriched data to the external application mapped to the supported format based on the configuration above


Continuously Enrich Contacts

Receive all newly created contacts, send it to your app API to enrich with the new data and update contact back

Greenhouse Harvest

BambooHR

Workable

Breezy HR

Lever

Ashby

# Realtime Full two-way Sync of Jobs

This scenario enables your application to fully sync Jobs between your app and any external application in both directions. It handles the initial import/export of Jobs and then sends events when a Job is created, updated, or deleted on any side, as close to real-time as possible.

Job fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Jobs in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Jobs to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Jobs

Bi-directional realtime sync of Jobs with records deduplication

Jobnimbus API Integration Profile

How to work with Jobs in Jobnimbus API

Operations on Jobs Collection

Build every single integration your customers need with AI

Field Name	API Key	Type	Description
Jnid	jnid	string	The primary key for the record.
Customer	customer	string	The id of the customer that this record is associated with.
Type	type	string	The record type.
Recid	recid	integer	An auto-incrementing number that is assigned to each new record of this type. It is used when generating the number field.
External Id	external_id	string	3rd party data import id, we can use it to link other records from 3rd party