This document describes how to construct API requests and handle responses from the JobNimbus API.
\nWhen building your API Request, you will need to pass along a few values: 1.) the content-type, 2.) the authorization (API key), 3.) the base URL, 3.) a set actor (optional), and 4.) your query (optional if performing a GET).
\nThe JobNimbus API Supports the following HTTP Methods:
\nGET
\nPUT
\nPOST
\nThe JobNimbus API is a REST-like API that allows exchanging data in JSON format, only. JSON responses use the application/json content-type.
\n{\n\"count\": 1,\n\"results\": [\n {\n ...\n \"first_name\": \"David\",\n \"display_name\": \"David JACKSON\",\n \"last_name\": \"JACKSON\",\n \"...\n }\n]}\n\nThe base URL for API endpoint requests:
\nhttps://app.jobnimbus.com/api1/\n\nIn order to obtain an API key, customers of JobNimbus must log into their account and go to settings - API -- New API key Select Profile -- Set the integration name (if existing) or type in the name in the Description box -save.
\nIf you're a developer working on a new integration, you can create a free trial account to develop with at https://www.jobnimbus.com/trial-signup.
\nTo authenticate requests, set an HTTP header named \"Authorization\" to \"Bearer \"
\nThe API token is a customer admin level token that grants permissions based on the 'Access Profile' that is associated with the token.
\nSample Token:
\njilqy9efy8jk79v9\n\nOptional: If the API token is associated with an 'Access Profile' that has admin level permissions, you can optionally pass an 'actor' query string parameter to cause the API request to inherit the permissions of a specific JobNimbus user account. This will also affect the 'Created By' value of the record in JobNimbus. For example, if you have a JobNimbus team member named Samantha Rawlings and her email address is sam@company.com, then if you passed her email address as the actor and created a contact in JobNimbus through the API, that contact would show up as having been created by Samantha. Additionally, if Samantha is a limited access user and you were to make a call to 'GET /contacts', the results would only include contacts that Samantha has access to.
\nExample:
\n\"https://app.jobnimbus.com/api1/contacts?actor=sam@company.com\"\n\nEach endpoint utilizes common parameters to customize how a request may be formatted, returns specific fields, or executes a requess. Below are the parameters that are available for our most commonly used endpoints (contacts, jobs, and notes):
\nsize - Controls the number of elements returned in the response.
\nDefault: 1000
\nRange: 1-1000 (maximum)
\nExample: ?size=100 returns 100 elements
Note: Use smaller values for faster response times or when you only need a subset of results
\nfrom - zero based starting point to be used for pagination (default: 0) Example: ?from=1
sort_field - which field to sort by (default: date_created). Example: ?sort_field=date_created
sort_direction = which direction to sort the results (default: 'desc') ?sort_direction=asc
fields - limit which fields to include in response (default: all fields will be included)
\nfilter - URL encoded JSON filter object. Please see following section.
\nbulk - This improves performance by optimistically saving the record. Note that subsequent “search” type queries might not include this record for several seconds. Example: ?bulk=true
skip (a comma separated list)- This causes JobNimbus to NOT perform various automated actions. Example: ?skip=automation,notification
automation - This bypasses any automation triggers, ensuring your automation rules don’t get triggered.
\nnotification - This bypasses sending any type of notification (email, push notification, etc).
\nWithin a GET request via the JobNimbus API, you are able to pass a query using ElasticSearch syntax (with JSON formatting). This query is passed at the end of the base URL within your request following a question mark and equal sign (?=).
\nExamples:
\nA GET request against the contacts API for a contact with the first name of \"John\":
\n?filter={\"must\":[{\"term\":{\"first_name\":\"John\"}}]}\n\nA GET request against the contacts API endpoint for all contacts with the first name of \"John\" and last name of \"Smith\" would use a query such as this:
\n?filter={\"must\":[{\"term\":{\"first_name\":\"john\"}},{\"term\":{\"last_name\":\"smith\"}}]}\n\nReturn all of the records related to a specific JobNimbus contact's or job's JobNimbus id (id/jnid)
\n?filter={\"must\":[{\"term\":{\"related.id\":\"abc12345\"}}]}\n\nReturn all of the contacts related to a specific JobNimbus contact's JobNimbus id (id/jnid) and a specific workflow name:
\n?filter={\"must\":[{\"term\":{\"related.id\":\"abc12345\"}},{\"term\":{\"record_type_name\":\"customer\"}}]}\n\nReturn all of the records based on multiple jnids (need to use terms here):
\n?filter={\"must\":[{\"terms\":{\"jnid\": [\"jnid1\",\"jnid2\"]}}]}\n\nReturn all of the records updated in the last 24 hours:
\n?filter={\"must\":[{\"range\":{\"date_updated\":{\"gte\":\"now-1d\"}}}]}\n\nReturn all of the records updated after a specific Unix timestamp (1747900000 = Thursday, 22 May 2025 07:46:40 UTC):
\n?filter={\"must\":[{\"range\":{\"date_updated\":{\"gte\":1747900000}}}]}\n\nIf you have created custom fields for contacts or jobs, you may have the need to access the information stored in these fields. Custom fields are created via the Contact Fields or Job Fields section of your JobNimbus Settings.
\nWhen viewing custom fields on a contact or job record from their respective endpoints, the custom fields will typically be labeled with the name assigned to them (i,e. “Date of Loss”) or a system-generated label for older custom fields. These system-generated custom fields will be pre-labeled with the prefix cf* annotating a custom field, an underscore, their field type, another underscore, and number for that field (i,e. “cf_string_1”).
\nThe following custom field types in JobNimbus will be passed in the following data formats via the API:
\nText: String
\nDate: Date
\nNumber: Long integer.
\nDecimal: Double integer.
\nBoolean: true/false
\nOptions list: string (separated by commas)
\nYou can update a custom field via the
\n\nand
\n\nsection of your JobNimbus Settings.
\nExample
\n...\n \"cf_string_1\": \"Two-leg. Requires sign-off by the spouse.\",\n \"cf_date_1\": 1550692800,\n \"Claim Number\": \"124523-f\",\n \"Date of Loss\": 1550692800\n...\n\nIn the payload of the request being sent to JobNimbus (the body of the data), there are certain characters in the field values that must be \"escaped\" (specially marked or notated with a backslash). Escaping these characters prevents the request from returning errors such as (415: Unsupport Media Type or 422: Unprocessable Entity).
\nPlease ensure all JSON payloads escape the following characters:
\nBackspace is replaced with \\b
Form feed is replaced with \\f
Newline is replaced with \\n
Carriage return is replaced with \\r
Tab is replaced with \\t
Double quote is replaced with \\\"
Backslash is replaced with \\\\
curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer <token>\" \"https://app.jobnimbus.com/api1/contacts?actor=sam@company.com?filter={\"must\":[{\"term\":{\"first_name\":\"John\"}},{\"term\":{\"last_name\":\"Smith\"}}}]}\"\n\nIt's important that you capture and relay API errors to either the end user or to a log file to assist with troubleshooting. If an API request fails, the HTTP response code will be something other than \"200\" and the response body should contain a helpful error message. Discarding these error messages without displaying them to either the end user or making them available to your customer support team will make troubleshooting difficult.
\nJobNimbus will not be able to assist with troubleshooting if errors are not properly captured.
\nIf an API request is failing, please contact support@jobnimbus.com with the following information:
\nThe request URL, including the query string
\nThe request payload
\nThe HTTP response error code and text message
\nThis request allows you to create a new contact within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to update a contact within JobNimbus.
\nNotes:
\nMandatory field(s): jnid
\nResponse Codes:
\nThis request allows you to update a contact within JobNimbus.
\nNotes:
\nMandatory field(s): jnid
\nResponse Codes:
\nThis request allows you to retrieve the information of a specific contact within JobNimbus.
\nNotes:
\nMandatory field(s): jnid
\nResponse Codes:
\nThis request allows you to retrieve all of the contacts within a JobNimbus account.
\nResponse Codes:
\nRequest Parameters
\nRequest parameters should be passed in the query string
\nsize - number of elements to return (default: 1000)
\nfrom - zero based starting point to be used for pagination (default: 0)
\nsort_field - which field to sort by (default: date_created)
\nsort_direction = which direction to sort the results (default: 'desc')
\nfields - limit which fields to include in response (default: all fields will be included)
\nfilter - URL encoded JSON filter object i.e.:
\n\n{\n \"must\": [\n {\n \"range\": {\n \"date_created\": {\n \"gte\": 1459749600,\n \"lte\": 1459835940\n }\n }\n }\n ]\n}\nResponse:
\nExample of a partial response:
\n{\n \"recid\": 1003,\n \"customer\": \"29a\",\n \"type\": \"contact\",\n \"created_by\": \"29b\",\n \"created_by_name\": \"Sam Burnet\",\n \"date_created\": 1459789425,\n \"date_updated\": 1460051077,\n \"owners\": [\n {\n \"id\": \"29b\"\n }\n ],\n \"location\": {\n \"id\": 1,\n \"parent_id\": null,\n \"name\": \"Developer Account\"\n },\n \"first_name\": \"Bruce\",\n \"last_name\": \"Wayne\",\n \"company\": \"Wayne Enterprises\",\n \"description\": \"Likes to wear costumes...\",\n \"email\": \"bruce@batman.com\",\n \"home_phone\": \"8882223333\",\n \"mobile_phone\": \"\",\n \"work_phone\": \"\",\n \"fax_number\": \"\",\n \"address_line1\": \"123 S. Bat Street\",\n \"address_line2\": null,\n \"city\": \"Heber City\",\n \"state_text\": \"UT\",\n \"country_name\": \"United States\",\n \"zip\": \"84032\",\n \"website\": \"www.batman.com\",\n \"record_type\": 1,\n \"record_type_name\": \"Customer\",\n \"status\": 2,\n \"status_name\": \"Inspection\",\n \"source\": 1,\n \"source_name\": \"Referral\",\n \"sales_rep\": \"1m1\",\n \"sales_rep_name\": \"Sam Burnet\",\n \"jnid\": \"1l7\",\n \"geo\": {\n \"lat\": 0,\n \"lon\": 0\n },\n ...\n}\nThe Contact API endpoint allows you to create, view, and update an individual or group of Contacts within JobNimbus.
\n/contacts\nhttps://app.jobnimbus.com/api1/contacts\n| Field Name | Description | Required to POST? | Format |
|---|---|---|---|
| jnid | The primary key for the record. | No | text |
| customer | The id of the customer that this record is associated with. | No | text |
| type | The record type. | No | text |
| recid | An auto-incrementing number that is assigned to each new record of this type. It is used when generating the number field. | No | long |
| external_id | 3rd party data import id, we can use it to link other records from 3rd party | No | text |
| class_id | The id of the class that this record is associated with. (currently using for referencing qb class) | No | text |
| class_name | The name of the class that this record is associated with. (currently using for referencing qb class) | No | text |
| number | The customer defined template generated number assigned to this record, based off of the record id. | No | text |
| created_by | The contact id that created this record. | No | text |
| created_by_name | The denormalized name of the contact that created this record. | No | text |
| date_created | The unix timestamp reflecting when this record was created. | No | date |
| date_updated | The unix timestamp reflecting when this record was updated. | No | date |
| location | If multi-location is enabled, the location this record is associated with. | No | array |
| is_active | Whether this record is active(true) or deleted(false). | No | boolean |
| rules | A list of workflow rule ids that have been triggered for this record. Used to prevent recursion. | No | text |
| is_archived | Whether this record has been archived (true) or not (false). | No | boolean |
| owners | The optional array list of owners for the record. | No | array |
| subcontractors | The optional list of subcontractors for the record. | No | array |
| color | color for subcontractor | No | text |
| date_start | The event start unix timestamp for this record. | No | date |
| date_end | The event end unix timestamp for this record. | No | date |
| tags | A comma separated list of string tags. | No | text |
| related | The optional list of related records for the record. | No | array |
| sales_rep | The denormalized sales_rep of the parent record. | No | text |
| sales_rep_name | The denormalized sales_rep_name of the parent record. | No | text |
| date_status_change | The unix timestamp reflecting when the status of this record was changed. | No | date |
| description | The description of this record. | No | text |
| address_line1 | The line 1 portion of the physical address. | No | text |
| address_line2 | The line 2 portion of the physical address. | No | text |
| city | The city portion of the physical address. | No | text |
| state_text | The state text portion of the physical address. | No | text |
| zip | The postal code portion of the physical address. | No | text |
| country_name | The country portion of the physical address. | No | text |
| record_type | The workflow type id for this record. | No | integer |
| record_type_name | The workflow type name for this record. | Yes | text |
| status | The workflow status id for this record. | No | integer |
| status_name | The workflow status name for this record. | Yes | text |
| source | The lead source id for this record. | No | integer |
| source_name | The lead source name for this record. | No | text |
| geo | The geo coordinates of the address associated with this record. | No | geo_point |
| image_id | The id of the image (avatar) associated with this record. | No | array |
| estimated_time | The number of minutes this record is estimated to take to complete. | No | long |
| actual_time | The number of minutes logged against this record toward completion. | No | long |
| task_count | The aggregated number of tasks associated with this record. | No | long |
| last_estimate | Most recent estimate value | No | double |
| last_invoice | Most recent invoice value | No | double |
| last_budget_gross_margin | Most recent budget gross margin | No | double |
| last_budget_gross_profit | Most recent budget gross profit | No | double |
| last_budget_revenue | Most recent budget revenue | No | double |
| is_lead | Whether this record is a lead or not. | No | boolean |
| is_closed | Whether this record is closed or not. | No | boolean |
| is_sub_contractor | Whether this contact is a subcontractor or not for User. | No | boolean |
| first_name | The first name of the person this contact record is associated with. | Yes* | text |
| last_name | The last name of the person this contact record is associated with. | Yes* | text |
| company | The company name that this contact record is associated with. | Yes* | text |
| display_name | Display name used mainly for QB syncing - unique field | Yes* | text |
| The email address associated with this contact. | No | text | |
| home_phone | The home phone number associated with this contact. | No | text |
| mobile_phone | The mobile phone number associated with this contact. | No | text |
| work_phone | The work phone number associated with this contact. | No | text |
| fax_number | The fax number associated with this contact. | No | text |
| website | The web site associated with this contact. | No | text |
*See conditions for \"POST Create a Contact\", below.
\n","event":[{"listen":"prerequest","script":{"id":"b147bfc2-757b-4bb5-809b-ba5022ef7baa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d20c953f-1877-41b3-bff1-f0935592f430","type":"text/javascript","exec":[""]}}],"_postman_id":"6ecbf20e-173f-4542-bc2d-20c61f4e9805"},{"name":"Jobs","item":[{"name":"Create a Job","event":[{"listen":"test","script":{"id":"93b25901-fa22-48cb-89e7-5d8d46f17074","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"e6c260a2-c593-4d58-8d61-f1edfaac63ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"bearerThis request allows you to create a new job within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to update a job within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to update a job within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to retrieve the information of a specific job within JobNimbus.
\nNotes:
\nMandatory field(s): jnid
\nResponse Codes:
\nThis request allows you to retrieve all of the jobs within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nRequest Parameters
\nRequest parameters should be passed in the query string
\nsize - number of elements to return (default: 1000)
\nfrom - zero based starting point to be used for pagination (default: 0)
\nsort_field - which field to sort by (default: date_created)
\nsort_direction = which direction to sort the results (default: 'desc')
\nfields - limit which fields to include in response (default: all fields will be included)
\nfilter - URL encoded JSON filter object i.e.:
\n{\n \"must\": [\n {\n \"range\": {\n \"date_created\": {\n \"gte\": 1459749600,\n \"lte\": 1459835940\n }\n }\n }\n ]\n}\n\nResponse:
\nExample of a partial response:
\n{ \n \"count\": 117,\n \"results\": [ \n {\n \"recid\": 1001,\n \"customer\": \"3oz\",\n \"type\": \"job\",\n \"created_by\": \"3p0\",\n \"created_by_name\": \"Bot Barton\",\n \"date_created\": 1472567571,\n \"date_updated\": 1472567572,\n \"location\": {\n \"id\": 1,\n \"parent_id\": null\n },\n \"owners\": [\n {\n \"id\": \"3p0\"\n }\n ],\n \"is_active\": true,\n \"name\": \"Test job\",\n \"number\": \"1001\",\n \"record_type\": 5,\n \"record_type_name\": \"Residential\",\n \"status\": 19,\n \"status_name\": \"Lead\",\n \"description\": null,\n \"sales_rep\": \"3p0\",\n \"sales_rep_name\": \"Bob Barton\",\n \"address_line1\": \"100 N 52 E\",\n \"address_line2\": \"\",\n \"city\": \"American Fork\",\n \"state_text\": \"UT\",\n \"country_name\": \"United States\",\n \"zip\": \"84003\",\n \"jnid\": \"3pg\",\n \"geo\": {\n \"lat\": 40.387368,\n \"lon\": -111.789513\n },\n ...\n]\n}\n\nThe Jobs API endpoint allows you to create, view, and update an individual or group of Jobs within JobNimbus.
\n/jobs\nhttps://app.jobnimbus.com/api1/jobs\n| Field Name: | Description: | Required to POST? | Format |
|---|---|---|---|
| jnid | The primary key for the record. | No | text |
| customer | The id of the customer that this record is associated with. | No | text |
| type | The record type. | No | text |
| recid | An auto-incrementing number that is assigned to each new record of this type. It is used when generating the number field. | No | long |
| external_id | 3rd party data import id, we can use it to link other records from 3rd party | No | text |
| number | The customer defined template generated number assigned to this record, based off of the record id. | No | text |
| created_by | The contact id that created this record. | No | text |
| created_by_name | The denormalized name of the contact that created this record. | No | text |
| rules | A list of workflow rule ids that have been triggered for this record. Used to prevent recursion. | No | text |
| date_created | The unix timestamp reflecting when this record was created. | No | date |
| date_updated | The unix timestamp reflecting when this record was updated. | No | date |
| location | If multi-location is enabled, the location this record is associated with. | No | array |
| is_active | Whether this record is active(true) or deleted(false). | No | boolean |
| is_archived | Whether this record has been archived (true) or not (false). | No | boolean |
| owners | The optional array list of owners for the record. | No | array |
| subcontractors | The optional list of subcontractors for the record. | No | array |
| date_start | The event start unix timestamp for this record. | No | date |
| date_end | The event end unix timestamp for this record. | No | date |
| tags | A comma separated list of string tags. | No | text |
| related | The optional list of related records for the record. | No | array |
| sales_rep | The denormalized sales_rep of the parent record. | No | text |
| sales_rep_name | The denormalized sales_rep_name of the parent record. | No | text |
| date_status_change | The unix timestamp reflecting when the status of this record was changed. | No | date |
| description | The description of this record. | No | text |
| address_line1 | The line 1 portion of the physical address. | No | text |
| address_line2 | The line 2 portion of the physical address. | No | text |
| city | The city portion of the physical address. | No | text |
| state_text | The state text portion of the physical address. | No | text |
| zip | The postal code portion of the physical address. | No | text |
| country_name | The country portion of the physical address. | No | text |
| record_type | The workflow type id for this record. | No | integer |
| record_type_name | The workflow type name for this record. | Yes | text |
| status | The workflow status id for this record. | No | integer |
| status_name | The workflow status name for this record. | Yes | text |
| source | The lead source id for this record. | No | integer |
| source_name | The lead source name for this record. | No | text |
| geo | The geo coordinates of the address associated with this record. | No | geo_point |
| image_id | The id of the image (avatar) associated with this record. | No | array |
| estimated_time | The number of minutes this record is estimated to take to complete. | No | long |
| actual_time | The number of minutes logged against this record toward completion. | No | long |
| task_count | The aggregated number of tasks associated with this record. | No | long |
| last_estimate | Most recent estimate value | No | double |
| last_invoice | Most recent invoice value | No | double |
| last_budget_gross_margin | Most recent budget gross margin | No | double |
| last_budget_gross_profit | Most recent budget gross profit | No | double |
| last_budget_revenue | Most recent budget revenue | No | double |
| is_lead | Whether this record is a lead or not. | No | boolean |
| is_closed | Whether this record is closed or not. | No | boolean |
| primary | An object that stores the primary record that is related to this record. | No | array |
| name | The name of the job. | Yes | text |
This request allows you to create a new task within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to update a job within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to update a job within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to retrieve the information of a specific task within JobNimbus.
\nNotes:
\nMandatory field(s): jnid
\nResponse Codes:
\nThis request allows you to retrieve all of the tasks within a JobNimbus account.
\nResponse Codes:
\nResponse:\nExample of a partial response:
\n{\n \"count\": 117,\n \"results\": [\n {\n \"external_id\": null,\n \"recid\": 1145,\n \"number\": \"1145\",\n \"customer\": \"jagpt\",\n \"type\": \"task\",\n \"created_by\": \"jagpu\",\n \"created_by_name\": \"Josh Demo\",\n \"date_created\": 1547742470,\n \"date_updated\": 1547742470,\n \"is_active\": true,\n \"is_archived\": false,\n \"primary\": null,\n \"actual_time\": 0,\n \"estimated_time\": 0,\n \"title\": \"Custom Task Type\",\n \"location\": {\n \"id\": 1\n },\n \"description\": \"New custom task type\",\n \"record_type\": 6,\n \"record_type_name\": \"Custom Task Type\",\n \"priority\": 0,\n \"date_start\": 1547712000,\n \"date_sort\": null,\n \"date_end\": 0,\n \"is_completed\": false,\n \"hide_from_calendarview\": false,\n \"hide_from_tasklist\": false,\n \"owners\": [\n {\n \"id\": \"jagpu\"\n }\n ],\n \"subcontractors\": [],\n \"related\": [\n {\n \"id\": \"ql1a9\",\n \"name\": \"Martin ROBERTS\",\n \"number\": \"1096\",\n \"type\": \"contact\"\n }\n ],\n \"jnid\": \"14yspl\",\n \"tags\": [],\n \"rules\": []\n },\n ]\n}\nThe Tasks API endpoint allows you to create, view, and update an individual or group of Tasks within JobNimbus.
\n/tasks\nhttps://app.jobnimbus.com/api1/tasks\n| Field Name: | Description: | Required to Post? | Format: |
|---|---|---|---|
| jnid | The primary key for the record. | No | text |
| customer | The id of the customer that this record is associated with. | No | text |
| type | The record type. | No | text |
| external_id | 3rd party data import id, we can use it to link other records from 3rd party | No | text |
| location | If multi-location is enabled, the location this record is associated with. | No | array |
| created_by | The contact id that created this record. | No | text |
| created_by_name | The denormalized name of the contact that created this record. | No | text |
| date_created | The unix timestamp reflecting when this record was created. | No | date |
| date_updated | The unix timestamp reflecting when this record was updated. | No | date |
| is_active | Whether this record is active(true) or deleted(false). | No | boolean |
| is_archived | Whether this record has been archived (true) or not (false). | No | boolean |
| owners | The optional array list of owners for the record. | No | array |
| subcontractors | The optional list of subcontractors for the record. | No | array |
| date_start | The event start unix timestamp for this record. | Yes | date |
| date_end | The event end unix timestamp for this record. | No | date |
| tags | A comma separated list of string tags. | No | text |
| recid | An auto-incrementing number that is assigned to each new record of this type. It is used when generating the number field. | No | long |
| number | The customer defined template generated number assigned to this record, based off of the record id. | No | text |
| rules | A list of workflow rule ids that have been triggered for this record. Used to prevent recursion. | No | text |
| related | The optional list of related records for the record. | Yes | array |
| description | The description of this record. | No | text |
| estimated_time | The number of minutes this record is estimated to take to complete. | No | long |
| actual_time | The number of minutes logged against this record toward completion. | No | long |
| is_completed | Whether this task has been marked completed (true) or not (false). | No | boolean |
| title | The title of the task | Yes | text |
| primary | An object that stores the primary record that is related to this record. | No | array |
| record_type | The id of the task type. | No | integer |
| record_type_name | The denormalized name of the task type. | Yes | text |
| priority | The numeric priority of the task. 0=none, 1=high, 2=medium, 3=low | No | integer |
This request allows you to create a new Activity within JobNimbus.
\nNotes:
\nResponse Codes:
\nThis request allows you to retrieve the information of a specific activity within JobNimbus.
\nNotes:
\nMandatory field(s): jnid
\nResponse Codes:
\nThis request allows you to retrieve all of the activities within a JobNimbus account.
\nResponse Codes:
\nRequest Parameters
\nRequest parameters should be passed in the query string
\nsize - number of elements to return (default: 1000)
\nfrom - zero based starting point to be used for pagination (default: 0)
\nsort_field - which field to sort by (default: date_created)
\nsort_direction = which direction to sort the results (default: 'desc')
\nfields - limit which fields to include in response (default: all fields will be included)
\nfilter - URL encoded JSON filter object i.e.:
\n\n{\n \"must\": [\n {\n \"range\": {\n \"date_created\": {\n \"gte\": 1459749600,\n \"lte\": 1459835940\n }\n }\n }\n ]\n}\nResponse:
\nExample of a partial response:
\n{\n \"count\": 10,\n \"activity\": [\n {\n \"type\": \"activity\",\n \"customer\": \"7z76o\",\n \"location\": {\n \"id\": 1\n },\n \"primary\": {\n \"new_status\": 13,\n \"id\": \"he2d2\",\n \"name\": \"Clark Kent\",\n \"type\": \"contact\",\n \"number\": \"1017\"\n },\n \"is_active\": true,\n \"note\": \"Contact Created\",\n \"is_status_change\": true,\n \"record_type_name\": \"Contact Created\",\n \"owners\": [],\n \"related\": [\n {\n \"id\": \"he2d2\",\n \"type\": \"contact\",\n \"name\": \"Clark Kent\",\n \"number\": \"1017\"\n }\n ],\n \"jnid\": \"he2d3\",\n \"created_by\": \"neo\",\n \"created_by_name\": \"Thomas Anderson\",\n \"date_created\": 1512763337,\n \"date_updated\": 1512763337,\n \"is_archived\": false,\n \"is_editable\": false\n },\n ...\n]\nThe Activities API endpoint allows you to create, view, and update an individual or group of activity within JobNimbus.
\n/activities\nhttps://app.jobnimbus.com/api1/activities\n| Field Name: | Description: | Required to Post? | Format: |
|---|---|---|---|
| jnid | The primary key for the record. | No | text |
| customer | The id of the customer that this record is associated with. | No | text |
| type | The record type. | No | text |
| external_id | 3rd party data import id, we can use it to link other records from 3rd party | No | text |
| created_by | The contact id that created this record. | No | text |
| created_by_name | The denormalized name of the contact that created this record. | No | text |
| date_created | The unix timestamp reflecting when this record was created. | No | date |
| date_updated | The unix timestamp reflecting when this record was updated. | No | date |
| is_active | Whether this record is active(true) or deleted(false). | No | boolean |
| is_archived | Whether this record has been archived (true) or not (false). | No | boolean |
| owners | The optional array list of owners for the record. | No | array |
| sales_rep | The denormalized sales_rep of the parent record. | No | text |
| sales_rep_name | The denormalized sales_rep_name of the parent record. | No | text |
| related | The optional list of related records for the record. | No | array |
| rules | A list of workflow rule ids that have been triggered for this record. Used to prevent recursion. | No | text |
| primary | The primary record that is related to this record (with status information). | Yes | array |
| is_private | Whether this record is private or not. | No | boolean |
| record_type | The activity type id for this record (null for system defined activity). | No | integer |
| email_status | The email status for which activity is linked to email record | No | text |
| Yes | The workflow type name for this record. | No | text |
| source | source from where this record created. | No | text |
| location | If multi-location is enabled, the location this record is associated with. | No | array |
| stack | Stack Trace for delete | No | array |
| note | The activity note text. | Yes | text |
| is_status_change | Whether or not this activity item is the result of a primary record status change. | No | boolean |
| is_editable | Whether or not this activity item is editable. | No | boolean |
This request allows you to create a new File attachment within JobNimbus.
\nNotes:
\n*Data attribute should be base64 encoded, ie. btoa('This is my document text.')
\nType:
\nResponse Codes:
\nResponse:
\n{\n \"count\": 165,\n \"files\": [\n {\n \"customer\": \"jagpt\",\n \"type\": \"attachment\",\n \"created_by\": \"jagpu\",\n \"created_by_name\": \"Josh Demo\",\n \"is_active\": true,\n \"filename\": \"Screen Shot 2018-06-26 at 8.39.48 PM.png\",\n \"content_type\": \"image/png\",\n \"size\": 555204,\n \"jnid\": \"jsy16hg9ztze7cxx\",\n \"date_created\": 1551926855,\n \"date_updated\": 1551926859,\n \"is_private\": false,\n \"related\": [\n {\n \"id\": \"scpci\",\n \"type\": \"contact\",\n \"name\": \"Jimmy Rivera III\"\n }\n ],\n \"primary\": {\n \"id\": \"scpci\",\n \"type\": \"contact\",\n \"number\": \"1164\",\n \"name\": \"Jimmy Rivera III\"\n },\n \"owners\": [\n {\n \"id\": \"jagpu\"\n }\n ],\n \"sales_rep\": \"jagpu\",\n \"is_archived\": false,\n \"record_type\": 2,\n \"record_type_name\": \"Photo\"\n }\n ]\n}\nThis request allows you to create a new File attachment within JobNimbus.
\nNotes:
\nData attribute should be base64 encoded, ie. btoa('This is my document text.')
\nType:
\n1=Document
\n2=Photo
\n3=Email Attachment
\n4=naturalForms
\n5=Invoice
\n6=Eagleview
\n7=Accurence
\n8=Credit Memo
\nrelated[] should be the jnid of the contact or job that this file should be attached to
\ntype should be set to a valid file type as defined in the JobNimbus customer settings. Usually this can be set to 'Photo'
\ndescription should be set to a photo caption/description
\nname should be set to the file name. If not supplied, the file name will be extracted from the url
\nurl should be set to the publicly accessable url of the image
\nResponse Codes:
\nUploading a file to your JobNimbus account is a 2 part process. You first have to get a Presigned URL that you can then use to PUT your file into the system. There are 2 endpoints to use depending on the size of the file to upload. If the file is <100MB, you should use the single part upload. If it is >100MB, you should use the multipart upload and upload the file in chunks.
\nThis is the endpoint used to get that presigned URL. It will only be valid for 15 minutes so make sure you do the PUT within that 15 minute timeout.
\nThis endpoint is ideal for files under 100MB in size. For larger files, you may want to use the 'Create a File (Multipart)' endpoint.
\nWhen doing the PUT, include the file in the body of the request as a binary payload.
\nWithin a few seconds of the PUT being completed, a thumbnail will be created if the file is an image or a PDF. If you want to get the URL of the thumbnail right away, you can call the /complete endpoint. This step is optional for a single part upload.
\nPOST
http://api.jobnimbus.com/files/v1/uploads/url
isPrivate (bool): true if the file is private to the uploader
related (Array of strings): an array of ids that this image is related to. Typically job ids, contact ids etc.
type (int): One of the following values
1=Document
\n2=Photo
\n3=Email Attachment
\n4=naturalForms
\n5=Invoice
\n6=Eagleview
\n7=Accurence
\n8=Credit Memo
\nXXX=Id of a custom type in the customers account
\nfilename (string): the name of the file including the extension
description (string): an optional description of the file being uploaded
Response Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nResponse:
\n{ \n \"data\": \n { \n \"url\": \"https://userdata-files-dev-us-west-2-jn.s3.us-west-2.amazonaws.com/.....\", \n \"jnid\": \"{ID OF THE FILE IN JOBNIMBUS}\" \n }\n}\n\nThis endpoint is used to complete the file upload process for a specific file identified by jnid. It allows you to finalize the upload and optionally generate a thumbnail for the uploaded file.
POST
https://api.jobnimbus.com/files/v1/uploads/:jnid/complete?generateThumbnail=true
Path Parameter:
\njnid (string): The unique identifier for the file being uploaded.Query Parameter:
\ngenerateThumbnail (boolean): A flag indicating whether a thumbnail should be generated for the uploaded file. Set to true to generate a thumbnail.HTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nHTTP 200\n{\n \"data\": {\n \"jnid\": \"{ID of the file}\",\n \"thumbnailUrl\": \"{URL for the thumbnail}\"\n }\n}\n\nEnsure that the jnid is valid and corresponds to a file that was just upload through the 'Create a File' process
The generateThumbnail parameter is optional; if not specified, the default behavior will be to not generate a thumbnail. If it is true, a url for the thumbnail will be returned in the response.
Proper error handling should be implemented to manage cases where the upload fails or the job ID is invalid.
\nThis endpoint is optional for completing file uploads. If you don't call this, the file will still be completed and a thumbnail will be created asynchronously.
\n","urlObject":{"protocol":"https","path":["files","v1","uploads",":jnid","complete"],"host":["api","jobnimbus","com"],"query":[{"key":"generateThumbnail","value":"true"}],"variable":[{"type":"any","value":"","key":"jnid"}]}},"response":[],"_postman_id":"bde74b87-bf90-4c4b-9db3-906ebc171f98"},{"name":"Upload Multipart File","id":"4ab6c3b5-072d-4436-9ce6-766e663369d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"partCount\": (number, required),\r\n \"fileSize\": (number, required),\r\n \"isPrivate\": (boolean, required),\r\n \"related\": [\r\n (array of strings, required)\r\n ],\r\n \"type\": (number, required),\r\n \"filename\": (string, required),\r\n \"description\": (string, required)\r\n}","options":{"raw":{"language":"json"}}},"url":"http://api.jobnimbus.com/files/v1/uploads/multi-urls","description":"This endpoint allows users to upload multiple URLs to the JobNimbus API. It is designed to facilitate the management of file uploads by associating them with specific resources or entities within the JobNimbus system.
\nPOST
https://api.jobnimbus.com/files/v1/uploads/multi-urls
partCount (number): The number of image parts that will be uploaded
fileSize (number): The size in bytes of the original image
isPrivate (boolean): Whether or not the image is private to the uploader
related (Array of strings): A string array of JNIDs of related objects in the JobNimbus system. Typically jobs or contacts.
type (number): One of the following values
1=Document
\n2=Photo
\n3=Email Attachment
\n4=naturalForms
\n5=Invoice
\n6=Eagleview
\n7=Accurence
\n8=Credit Memo
\nXXX=Id of a custom type in the customers account
\nfilename (string): the name of the file including the extension
description (string): an optional description of the file being uploaded
HTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\n{\n \"partCount\": 3,\n \"fileSize\": 100000000,\n \"isPrivate\": false,\n \"related\": [\n \"{JobNimbus Job ID}\"\n ],\n \"type\": 2,\n \"filename\": \"myphoto.jpg\",\n \"description\": \"a picure of a roof\"\n}\n\nIf successful, this will return an array of presigned urls. One url for each part needing to be uploaded. You will need to split your file into that many parts and upload each part to the appropriate url in the array.
\n{\n \"data\": {\n \"presignedUrls\": [\n \"https://userdata-files-dev-us-west-2-jn.s3.us-west-2.amazonaws.com/...\",\n \"https://userdata-files-dev-us-west-2-jn.s3.us-west-2.amazonaws.com/...\",\n \"https://userdata-files-dev-us-west-2-jn.s3.us-west-2.amazonaws.com/...\"\n ],\n \"jnid\": \"{the ID of the file uploaded}\",\n \"uploadId\": \"pcbG7KkXP8tJJ5DyvYyU3G3bqOKY_0lRNZkK6CKgx3MFQeKaEgzoJsusKwR6cO.SKXoJLbmOqlyLc3cPy99yqYFbmfK.RW_3SgsdDJ1LpeHIGK2FMPTqomAOMQwGzhdrF9aH9xiTlvrTRKHQNs0ceVixmwsZ9NqZXMBkvdlnn1c-\"\n }\n}\n\nEach file part must be >5MB except for the last one.
\nMake sure to upload each file in the same order as the presigned URLs using PUT in the same way as (Create a File).
\nYou must call the /files/v1/uploads/multi-complete endpoint after uploading all the parts. Otherwise, the file will not be assembled on the backend and it will not e available to you.
\nThis endpoint is designed to complete a multi-part file upload process in the JobNimbus API. It allows users to finalize the upload of files that have been previously initiated in multiple parts.
\nPOST
https://api.jobnimbus.com/files/v1/uploads/:jnid/complete?generateThumbnail=true
jnid (string): The jnid of the file being upload. Returned by the /multi-urls endpoint.
parts (Array of Objects): This key holds an array of objects representing the parts of the file that have been uploaded. Each object requires 2 properties:
partNumber (int): the ordinal number of the uploaded part
etag: The etag of the upload. This is returned in the etag header response of the PUT call for each individual uploaded part.
generateThumbnail (bool): Whether or not to generate the thumbnail right away. If this is true, the url will be returned in the response. Otherwise, the thumbnail will get created asynchronously.
HTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\n{\n \"jnid\": (string required),\n \"uploadId\": (string required),\n \"parts\": [\n {\n \"partNumber\": (number required),\n \"etag\": (string required)\n }\n ],\n \"generateThumbnail\": (bool optional)\n}\n\nHTTP 200\n{\n \"jnid\": \"{The ID of the file}\",\n \"thumbnailUrl\": \"{The URL of the thumbnail if one was created}\"\n}\n\nEnsure that all parts of the file have been uploaded before calling this endpoint.
\nProper error handling should be implemented to manage any issues that may arise during the completion of the upload.
\nThis endpoint allows users to abort a multi-file upload process. It is particularly useful when there are multiple files being uploaded and the user decides to cancel the operation.
\nPOST
http://api.jobnimbus.com/files/v1/uploads/multi-abort
key (string): The key of the file to abort. This will be the string {customerJnid}/{File Jnid}
uploadId (string): This is the upload Id that is returned by the 'Create a File (Multipart)' endpoint
HTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\n{\n \"key\": (string required),\n \"uploadId\": (string required)\n}\n\nThe response for this request will typically indicate the success or failure of the abort operation. Users should expect a status code that reflects the outcome of the request, along with any relevant messages or error codes.
\nEnsure that you are authenticated before making this request.
\nThis operation does not require any specific parameters in the request body.
\nConsider using this endpoint when you need to cancel ongoing multi-file uploads to manage resources effectively.
\nThis endpoint allows users to upload a file to a specified location using a presigned URL generated from the 'Create a File' or 'Create a File (Multipart)' call. The presigned URL provides temporary access to upload files directly to a storage service without requiring additional authentication.
\nPUT
The URL will be returned by either the /uploads/url or /uploads/multi-url endpoint
The request does not require a specific body format, as it is designed to upload a file directly to the presigned URL. The file data should be included in the request body.
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nPUT {presigned_url}\nContent-Type: application/octet-stream\n<binary file data>\n\nThis request allows you to retrieve the information of all of the file attachments within a JobNimbus account.
\nResponse Codes:
\nResponse:
\nExample of a partial response:
\n{\n \"count\": 165,\n \"files\": [\n {\n \"customer\": \"jagpt\",\n \"type\": \"attachment\",\n \"created_by\": \"jagpu\",\n \"created_by_name\": \"Josh Demo\",\n \"is_active\": true,\n \"filename\": \"Screen Shot 2018-06-26 at 8.39.48 PM.png\",\n \"content_type\": \"image/png\",\n \"size\": 555204,\n \"jnid\": \"jsy16hg9ztze7cxx\",\n \"date_created\": 1551926855,\n \"date_updated\": 1551926859,\n \"is_private\": false,\n \"related\": [\n {\n \"id\": \"scpci\",\n \"type\": \"contact\",\n \"name\": \"Jimmy Rivera III\"\n }\n ],\n \"primary\": {\n \"id\": \"scpci\",\n \"type\": \"contact\",\n \"number\": \"1164\",\n \"name\": \"Jimmy Rivera III\"\n },\n \"owners\": [\n {\n \"id\": \"jagpu\"\n }\n ],\n \"sales_rep\": \"jagpu\",\n \"is_archived\": false,\n \"record_type\": 2,\n \"record_type_name\": \"Photo\"\n }\n ]\n}\nThis request allows you to retrieve a file attachments within a JobNimbus account.
\nNotes:
\nMandatory field(s): jnid
\nResponse Codes:
\nHTTP Status 200 = success.
\nAnything other status code = failure and will include an error message in the response.
\nThe Files API endpoint allows you to create, view, and update an individual or group of files within JobNimbus.
\n/files\nhttps://app.jobnimbus.com/api1/files\n| Field Name: | Description: | Required to POST? | Format: |
|---|---|---|---|
| id | The primary key for the record. | No | text |
| type | The record type. | Yes | text |
| customer | The id of the customer that this record is associated with. | No | text |
| date_created | The unix timestamp reflecting when this record was created. | No | date |
| date_updated | The unix timestamp reflecting when this record was updated. | No | date |
This request allows you to create a product within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nAdditional Information:
\nOnly 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.
\nThe 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.
This request allows you to update a specific product within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nAdditional Information:
\nOnly 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.
\nThe 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.
This request allows you to update a specific product within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nAdditional Information:
\nOnly 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.
\nThe 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.
This request allows you to retrieve a specific product within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis request allows you to retrieve all of the products within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThe Products API endpoint allows you to create, view, and update a Product & Services within JobNimbus.
\nPlain Text
\n/v2/products\n\nPlain Text
\nhttps://app.jobnimbus.com/api1/v2/products\n\nEach UOM (Unit of Measurement) object contains:
\nBoth material and labor objects contain:
\n","_postman_id":"42679756-6d1c-430f-8755-b54c38e163ce"},{"name":"MaterialOrders","item":[{"name":"Create a MaterialOrder","id":"fbe4b88f-d87c-4bfb-8b37-868c955d7f49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"bearerThis request allows you to retrieve a specific material order within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThe Material Orders API endpoint allows you to create, view, and update an individual or group of Material Orders within JobNimbus.
\n/v2/workorders\n\nThis request allows you to create a work order within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis request allows you to update a specific work order within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis request allows you to update a specific work order within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis request allows you to retrieve a specific work order within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis request allows you to retrieve all of the work orders within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nQuery Parameters:
\nfrom: Starting index for pagination (e.g., 10)
size: Number of results to return (e.g., 5)
Additional details:
\nsize 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.
The WorkOrders API endpoint allows you to create, view, and update an individual or group of WorkOrders within JobNimbus.
\n/v2/workorders\n\nThis request allows you to create a new estimate within JobNimbus.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis endpoint allows you to update an existing Estimate within JobNimbus.
\ntype: '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.
The response of this request can be documented as a JSON schema. Here is a partial example of the response:
\n{\n \"type\": \"estimate\",\n \"external_id\": null,\n \"guid\": \"12345678-ABCD-1234-EFGH-1234567890AB\",\n \"merged\": null,\n \"class_id\": null,\n \"class_name\": null,\n \"supplier\": null,\n \"recid\": 1000,\n \"attachment_id\": \"ATTACHMENT_ID_123\",\n \"customer\": \"CUSTOMER_ID_123\",\n \"created_by\": \"system_qbo\",\n \"created_by_name\": \"QuickBooks\",\n \"date_created\": 1600000000,\n \"date_updated\": 1600000001,\n \"esigned\": false,\n \"is_active\": true,\n \"is_archived\": true,\n \"related\": [\n {\n \"id\": \"JOB_ID_123\",\n \"name\": \"John Doe / PROJECT-123\",\n \"number\": \"1000\",\n \"type\": \"job\",\n \"email\": null,\n \"subject\": null\n },\n {\n \"id\": \"CONTACT_ID_123\",\n \"name\": \"John Doe (CLIENT-123)\",\n \"number\": \"2000\",\n \"type\": \"contact\",\n \"email\": null,\n \"subject\": null\n }\n ],\n \"status\": 4,\n \"status_name\": \"Closed\",\n \"number\": \"INV-001\",\n \"location\": {\n \"id\": 1\n },\n \"subtotal\": 10000,\n \"margin\": 0,\n \"tax\": 0,\n \"total\": 10000,\n \"cost\": 10000,\n \"terms\": null,\n \"note\": \"\",\n \"date_estimate\": 1600000003,\n \"date_status_change\": 1600000004,\n \"items\": [\n {\n \"quickbooksId\": \"1\",\n \"showGroupTotal\": null,\n \"addMarkup\": null,\n \"photos\": [],\n \"jnid\": \"ITEM_ID_123\",\n \"name\": \"Service\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"description\": \"John Doe / PROJECT-123 / SERVICE\",\n \"quantity\": 1,\n \"price\": 10000,\n \"preSurchargePrice\": null,\n \"cost\": 10000,\n \"amount\": 10000,\n \"tax_couch_id\": null,\n \"tax_name\": null,\n \"tax_rate\": 0,\n \"labor\": {\n \"quickbooksId\": null,\n \"price\": 0,\n \"preSurchargePrice\": null,\n \"cost\": 0,\n \"addMarkup\": null,\n \"amount\": 0,\n \"tax_couch_id\": null,\n \"tax_name\": null,\n \"tax_rate\": 0\n },\n \"sku\": null,\n \"color\": null,\n \"category\": null\n }\n ],\n \"sections\": [],\n \"owners\": [\n {\n \"id\": \"OWNER_ID_123\"\n }\n ],\n \"sales_rep\": \"SALES_REP_ID_123\",\n \"sales_rep_name\": \"Jane Smith\",\n \"jnid\": \"INVOICE_ID_123\",\n \"internal_note\": \"\",\n \"template_id\": \"TEMPLATE_ID_123\"\n}\n\nResponse JSON Schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\"type\": \"string\"},\n \"external_id\": {\"type\": [\"string\", \"null\"]},\n \"guid\": {\"type\": \"string\"},\n \"merged\": {\"type\": [\"string\", \"null\"]},\n \"class_id\": {\"type\": [\"string\", \"null\"]},\n \"class_name\": {\"type\": [\"string\", \"null\"]},\n \"supplier\": {\"type\": [\"string\", \"null\"]},\n \"recid\": {\"type\": \"integer\"},\n \"attachment_id\": {\"type\": \"string\"},\n \"customer\": {\"type\": \"string\"},\n \"created_by\": {\"type\": \"string\"},\n \"created_by_name\": {\"type\": \"string\"},\n \"date_created\": {\"type\": \"integer\"},\n \"date_updated\": {\"type\": \"integer\"},\n \"esigned\": {\"type\": \"boolean\"},\n \"is_active\": {\"type\": \"boolean\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"related\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"number\": {\"type\": \"string\"},\n \"type\": {\"type\": \"string\"},\n \"email\": {\"type\": [\"string\", \"null\"]},\n \"subject\": {\"type\": [\"string\", \"null\"]}\n }\n }\n },\n \"status\": {\"type\": \"integer\"},\n \"status_name\": {\"type\": \"string\"},\n \"number\": {\"type\": \"string\"},\n \"location\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"integer\"}\n }\n },\n \"subtotal\": {\"type\": \"integer\"},\n \"margin\": {\"type\": \"integer\"},\n \"tax\": {\"type\": \"integer\"},\n \"total\": {\"type\": \"integer\"},\n \"cost\": {\"type\": \"integer\"},\n \"note\": {\"type\": \"string\"},\n \"date_estimate\": {\"type\": \"integer\"},\n \"date_status_change\": {\"type\": \"integer\"},\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"quickbooksId\": {\"type\": [\"string\", \"null\"]},\n \"showGroupTotal\": {\"type\": [\"string\", \"null\"]},\n \"addMarkup\": {\"type\": [\"string\", \"null\"]},\n \"photos\": {\"type\": \"array\"},\n \"jnid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"uom\": {\"type\": \"string\"},\n \"item_type\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"quantity\": {\"type\": \"integer\"},\n \"price\": {\"type\": \"integer\"},\n \"preSurchargePrice\": {\"type\": [\"string\", \"null\"]},\n \"cost\": {\"type\": \"integer\"},\n \"amount\": {\"type\": \"integer\"},\n \"tax_couch_id\": {\"type\": [\"string\", \"null\"]},\n \"tax_name\": {\"type\": [\"string\", \"null\"]},\n \"tax_rate\": {\"type\": \"integer\"},\n \"labor\": {\n \"type\": \"object\",\n \"properties\": {\n \"quickbooksId\": {\"type\": [\"string\", \"null\"]},\n \"price\": {\"type\": \"integer\"},\n \"preSurchargePrice\": {\"type\": [\"string\", \"null\"]},\n \"cost\": {\"type\": \"integer\"},\n \"addMarkup\": {\"type\": [\"string\", \"null\"]},\n \"amount\": {\"type\": \"integer\"},\n \"tax_couch_id\": {\"type\": [\"string\", \"null\"]},\n \"tax_name\": {\"type\": [\"string\", \"null\"]},\n \"tax_rate\": {\"type\": \"integer\"}\n }\n },\n \"sku\": {\"type\": [\"string\", \"null\"]},\n \"color\": {\"type\": [\"string\", \"null\"]},\n \"category\": {\"type\": [\"string\", \"null\"]}\n }\n }\n },\n \"sections\": {\"type\": \"array\"},\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"}\n }\n }\n },\n \"sales_rep\": {\"type\": \"string\"},\n \"sales_rep_name\": {\"type\": \"string\"},\n \"jnid\": {\"type\": \"string\"},\n \"internal_note\": {\"type\": \"string\"},\n \"template_id\": {\"type\": \"string\"},\n \"version\": {\"type\": [\"string\", \"null\"]},\n \"duplicate_from_id\": {\"type\": [\"string\", \"null\"]}\n }\n}\n\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis endpoint allows you to update an existing estimate within JobNimbus.
\nis_active: Indicates if the estimate is active or notThe response of this request can be documented as a JSON schema. Here is a partial example of the response:
\n{ \n \"is_active\": false, \n \"type\": \"estimate\",\n \"date_created\": 1683819562,\n \"date_updated\": 1684160281,\n \"date_estimate\": 1683781200,\n \"external_id\": \"993479\",\n \"number\": \"1047\",\n \"status\": 1, \n \"internal_note\": \"Project Estimate\",\n \"related\": [\n {\n \"id\": \"lyu27jrnumcrz2u89k3ydyr\",\n \"type\": \"job\"\n }\n ],\n \"items\": [\n {\n \"name\": \"Services\",\n \"description\": \"Test and Troy Coon / SIDING\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"quantity\": 1,\n \"price\": 15438.99,\n \"jnid\": \"lyqi3qx3ee8hvnwh8g53wo9\"\n },\n {\n \"name\": \"Services\",\n \"description\": \"Shake siding\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"quantity\": 1,\n \"price\": 1303,\n \"jnid\": \"lyqi3qx3ee8hvnwh8g53wo9\"\n },\n {\n \"name\": \"Services\",\n \"description\": \"Remove Lights\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"quantity\": 1,\n \"price\": -349.52,\n \"jnid\": \"lyqi3qx3ee8hvnwh8g53wo9\"\n }\n ]\n}\n\nResponse JSON Schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\"type\": \"string\"},\n \"external_id\": {\"type\": [\"string\", \"null\"]},\n \"guid\": {\"type\": \"string\"},\n \"merged\": {\"type\": [\"string\", \"null\"]},\n \"class_id\": {\"type\": [\"string\", \"null\"]},\n \"class_name\": {\"type\": [\"string\", \"null\"]},\n \"supplier\": {\"type\": [\"string\", \"null\"]},\n \"recid\": {\"type\": \"integer\"},\n \"attachment_id\": {\"type\": \"string\"},\n \"customer\": {\"type\": \"string\"},\n \"created_by\": {\"type\": \"string\"},\n \"created_by_name\": {\"type\": \"string\"},\n \"date_created\": {\"type\": \"integer\"},\n \"date_updated\": {\"type\": \"integer\"},\n \"esigned\": {\"type\": \"boolean\"},\n \"is_active\": {\"type\": \"boolean\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"related\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"number\": {\"type\": \"string\"},\n \"type\": {\"type\": \"string\"},\n \"email\": {\"type\": [\"string\", \"null\"]},\n \"subject\": {\"type\": [\"string\", \"null\"]}\n }\n }\n },\n \"status\": {\"type\": \"integer\"},\n \"status_name\": {\"type\": \"string\"},\n \"number\": {\"type\": \"string\"},\n \"location\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"integer\"}\n }\n },\n \"subtotal\": {\"type\": \"integer\"},\n \"margin\": {\"type\": \"integer\"},\n \"tax\": {\"type\": \"integer\"},\n \"total\": {\"type\": \"integer\"},\n \"cost\": {\"type\": \"integer\"},\n \"terms\": {\"type\": [\"string\", \"null\"]},\n \"note\": {\"type\": \"string\"},\n \"date_estimate\": {\"type\": \"integer\"},\n \"date_status_change\": {\"type\": \"integer\"},\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"quickbooksId\": {\"type\": [\"string\", \"null\"]},\n \"showGroupTotal\": {\"type\": [\"string\", \"null\"]},\n \"addMarkup\": {\"type\": [\"string\", \"null\"]},\n \"photos\": {\"type\": \"array\"},\n \"jnid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"uom\": {\"type\": \"string\"},\n \"item_type\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"quantity\": {\"type\": \"integer\"},\n \"price\": {\"type\": \"integer\"},\n \"preSurchargePrice\": {\"type\": [\"string\", \"null\"]},\n \"cost\": {\"type\": \"integer\"},\n \"amount\": {\"type\": \"integer\"},\n \"tax_couch_id\": {\"type\": [\"string\", \"null\"]},\n \"tax_name\": {\"type\": [\"string\", \"null\"]},\n \"tax_rate\": {\"type\": \"integer\"},\n \"labor\": {\n \"type\": \"object\",\n \"properties\": {\n \"quickbooksId\": {\"type\": [\"string\", \"null\"]},\n \"price\": {\"type\": \"integer\"},\n \"preSurchargePrice\": {\"type\": [\"string\", \"null\"]},\n \"cost\": {\"type\": \"integer\"},\n \"addMarkup\": {\"type\": [\"string\", \"null\"]},\n \"amount\": {\"type\": \"integer\"},\n \"tax_couch_id\": {\"type\": [\"string\", \"null\"]},\n \"tax_name\": {\"type\": [\"string\", \"null\"]},\n \"tax_rate\": {\"type\": \"integer\"}\n }\n },\n \"sku\": {\"type\": [\"string\", \"null\"]},\n \"color\": {\"type\": [\"string\", \"null\"]},\n \"category\": {\"type\": [\"string\", \"null\"]}\n }\n }\n },\n \"sections\": {\"type\": \"array\"},\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\"}\n }\n }\n },\n \"sales_rep\": {\"type\": \"string\"},\n \"sales_rep_name\": {\"type\": \"string\"},\n \"jnid\": {\"type\": \"string\"},\n \"internal_note\": {\"type\": \"string\"},\n \"template_id\": {\"type\": \"string\"},\n \"version\": {\"type\": [\"string\", \"null\"]},\n \"duplicate_from_id\": {\"type\": [\"string\", \"null\"]}\n }\n}\n\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis endpoint allows you to retrieve a single estimate within a JobNimbus account by providing the estimateID in the URL.
This is a GET request and does not require a request body.
\nThe 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:
\n{\n \"type\": \"estimate\",\n \"guid\": \"12345678-ABCD-1234-EFGH-1234567890AB\",\n \"recid\": 1000,\n \"attachment_id\": \"ATTACHMENT_ID_123\",\n \"customer\": \"CUSTOMER_ID_123\",\n \"created_by\": \"system_qbo\",\n \"created_by_name\": \"QuickBooks\",\n \"date_created\": 1600000000,\n \"date_updated\": 1600000001,\n \"esigned\": false,\n \"is_active\": true,\n \"is_archived\": true,\n \"related\": [\n {\n \"id\": \"JOB_ID_123\",\n \"name\": \"John Doe / PROJECT-123\",\n \"number\": \"1000\",\n \"type\": \"job\",\n \"email\": null,\n \"subject\": null\n },\n {\n \"id\": \"CONTACT_ID_123\",\n \"name\": \"John Doe (CLIENT-123)\",\n \"number\": \"2000\",\n \"type\": \"contact\",\n \"email\": null,\n \"subject\": null\n }\n ],\n \"status\": 4,\n \"status_name\": \"Closed\",\n \"number\": \"EST-001\",\n \"location\": {\n \"id\": 1\n },\n \"subtotal\": 10000,\n \"margin\": 0,\n \"tax\": 0,\n \"total\": 10000,\n \"cost\": 10000,\n \"terms\": null,\n \"note\": \"\",\n \"date_estimate\": 1600000003,\n \"date_status_change\": 1600000004,\n \"items\": [\n {\n \"jnid\": \"ITEM_ID_123\",\n \"name\": \"Service\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"description\": \"John Doe / PROJECT-123 / SERVICE\",\n \"quantity\": 1,\n \"price\": 10000,\n \"cost\": 10000,\n \"amount\": 10000\n }\n ],\n \"sections\": [],\n \"owners\": [\n {\n \"id\": \"OWNER_ID_123\"\n }\n ],\n \"sales_rep\": \"SALES_REP_ID_123\",\n \"sales_rep_name\": \"Jane Smith\",\n \"jnid\": \"INVOICE_ID_123\",\n \"internal_note\": \"\",\n \"template_id\": \"TEMPLATE_ID_123\",\n \"first_payment_date\": 1600000006\n}\n\nThis endpoint allows you to retrieve all estimates within a JobNimbus account.
\nRequest Parameters:
\nfrom (optional): Starting index for pagination (e.g., 10)
size (optional): Number of results to return (e.g., 5)
Response:
\nThe response will contain an array of estimates with the following fields:
\nattachment_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:
\n{\n \"count\": 1000,\n \"results\": [\n {\n \"attachment_id\": \"attachmentjnid\",\n \"cost\": 10000,\n \"created_by\": \"system_qbo\",\n \"created_by_name\": \"QuickBooks\",\n \"customer\": \"customerjnid\",\n \"date_created\": 1600000000,\n \"date_estimate\": 1600000000,\n \"date_sign_requested\": 1600000000,\n \"date_signed\": 1600000000,\n \"date_status_change\": 1600000000,\n \"date_updated\": 1600000000,\n \"esigned\": false,\n \"guid\": \"12345678-ABCD-1234-EFGH-1234567890AB\",\n \"is_active\": true,\n \"is_archived\": true,\n \"items\": [\n {\n \"amount\": 10000,\n \"cost\": 10000,\n \"item_type\": \"material\",\n \"name\": \"Service\",\n \"price\": 10000,\n \"quantity\": 1,\n \"uom\": \"Items\"\n }\n ],\n \"jnid\": \"Estimate_ID\",\n \"location\": {\n \"id\": 1\n },\n \"margin\": 0,\n \"number\": \"EST-001\",\n \"owners\": [\n {\n \"id\": \"OWNER_ID_1\"\n }\n ],\n \"recid\": 1000,\n \"related\": [\n {\n \"id\": \"JOB_ID_1\",\n \"name\": \"Sample Project / SAMPLE-ID\",\n \"number\": \"1000\",\n \"type\": \"job\"\n },\n {\n \"id\": \"CONTACT_ID_1\",\n \"name\": \"John Doe (SAMPLE-ID)\",\n \"number\": \"1001\",\n \"type\": \"contact\"\n }\n ],\n \"sales_rep\": \"salesrepjnid\",\n \"sales_rep_name\": \"Jane Smith\",\n \"sections\": [],\n \"status\": 4,\n \"status_name\": \"Closed\",\n \"subtotal\": 10000,\n \"tax\": 0,\n \"template_id\": \"templatejnid\",\n \"total\": 10000,\n \"type\": \"estimate\"\n }\n ]\n}\n\nResponse Codes:
\nHTTP Status 200: Success
\nAny other status code: Failure with an error message in the response
\nThe Estimates API endpoint allows you to create, view, and update an individual or group of Estimates within JobNimbus.
\n/v2/estimates\n\nhttps://app.jobnimbus.com/api1/v2/estimates\n\nThis request allows you to create a new invoice within JobNimbus.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis request allows you to update an existing invoice within JobNimbus.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nResponse:
\nExample of a partial response:
\n{\n \"type\": \"invoice\",\n \"external_id\": null,\n \"guid\": \"12345678-ABCD-1234-EFGH-1234567890AB\",\n \"merged\": null,\n \"class_id\": null,\n \"class_name\": null,\n \"supplier\": null,\n \"recid\": 1000,\n \"attachment_id\": \"ATTACHMENT_ID_123\",\n \"customer\": \"CUSTOMER_ID_123\",\n \"created_by\": \"system_qbo\",\n \"created_by_name\": \"QuickBooks\",\n \"date_created\": 1600000000,\n \"date_updated\": 1600000001,\n \"esigned\": false,\n \"is_active\": true,\n \"is_archived\": true,\n \"related\": [\n {\n \"id\": \"JOB_ID_123\",\n \"name\": \"John Doe / PROJECT-123\",\n \"number\": \"1000\",\n \"type\": \"job\",\n \"email\": null,\n \"subject\": null\n },\n {\n \"id\": \"CONTACT_ID_123\",\n \"name\": \"John Doe (CLIENT-123)\",\n \"number\": \"2000\",\n \"type\": \"contact\",\n \"email\": null,\n \"subject\": null\n }\n ],\n \"status\": 4,\n \"status_name\": \"Closed\",\n \"number\": \"INV-001\",\n \"location\": {\n \"id\": 1\n },\n \"subtotal\": 10000,\n \"margin\": 0,\n \"tax\": 0,\n \"total\": 10000,\n \"cost\": 10000,\n \"total_paid\": 10000,\n \"due\": 0,\n \"terms\": null,\n \"note\": \"\",\n \"date_due\": 1600000002,\n \"date_invoice\": 1600000003,\n \"date_status_change\": 1600000004,\n \"date_paid_in_full\": 1600000005,\n \"items\": [\n {\n \"quickbooksId\": \"1\",\n \"showGroupTotal\": null,\n \"addMarkup\": null,\n \"addMarkupIsExcluded\": null,\n \"photos\": [],\n \"jnid\": \"ITEM_ID_123\",\n \"name\": \"Service\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"description\": \"John Doe / PROJECT-123 / SERVICE\",\n \"quantity\": 1,\n \"price\": 10000,\n \"preSurchargePrice\": null,\n \"cost\": 10000,\n \"amount\": 10000,\n \"tax_couch_id\": null,\n \"tax_name\": null,\n \"tax_rate\": 0,\n \"labor\": {\n \"quickbooksId\": null,\n \"price\": 0,\n \"preSurchargePrice\": null,\n \"cost\": 0,\n \"addMarkup\": null,\n \"addMarkupIsExcluded\": null,\n \"amount\": 0,\n \"tax_couch_id\": null,\n \"tax_name\": null,\n \"tax_rate\": 0\n },\n \"sku\": null,\n \"color\": null,\n \"category\": null\n }\n ],\n \"sections\": [],\n \"payments\": [],\n \"owners\": [\n {\n \"id\": \"OWNER_ID_123\"\n }\n ],\n \"sales_rep\": \"SALES_REP_ID_123\",\n \"sales_rep_name\": \"Jane Smith\",\n \"jnid\": \"INVOICE_ID_123\",\n \"internal_note\": \"\",\n \"template_id\": \"TEMPLATE_ID_123\",\n \"first_payment_date\": 1600000006,\n \"version\": null,\n \"duplicate_from_id\": null\n}\n\nThis request allows you to delete an existing invoice within JobNimbus.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nResponse:
\nExample of a partial response:
\n{ \n \"is_active\": false,\n \"type\": \"invoice\",\n \"date_created\": 1683819562,\n \"date_updated\": 1684160281,\n \"date_invoice\": 1683781200,\n \"date_due\": 1683781200,\n \"external_id\": \"993479\",\n \"number\": \"1047-795\",\n \"status\": 1, \n \"internal_note\": \"Project Invoice\",\n \"related\": [\n {\n \"id\": \"{jobId}\",\n \"type\": \"job\"\n }\n ],\n \"items\": [\n {\n \"name\": \"Services\",\n \"description\": \"Test and Troy Coone / SIDING\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"quantity\": 1,\n \"price\": 15438.99,\n \"jnid\": \"{itemId}\"\n },\n {\n \"name\": \"Services\",\n \"description\": \"Shake siding\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"quantity\": 1,\n \"price\": 1303,\n \"jnid\": \"{itemId}\"\n },\n {\n \"name\": \"Services\",\n \"description\": \"Remove Lights\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"quantity\": 1,\n \"price\": -349.52,\n \"jnid\": \"{itemId}\"\n }\n ]\n}\n\nThis request allows you to retrieve a single invoice within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nResponse:
\nExample of a partial response:
\n{\n \"type\": \"invoice\",\n \"external_id\": null,\n \"guid\": \"12345678-ABCD-1234-EFGH-1234567890AB\",\n \"merged\": null,\n \"class_id\": null,\n \"class_name\": null,\n \"supplier\": null,\n \"recid\": 1000,\n \"attachment_id\": \"ATTACHMENT_ID_123\",\n \"customer\": \"CUSTOMER_ID_123\",\n \"created_by\": \"system_qbo\",\n \"created_by_name\": \"QuickBooks\",\n \"date_created\": 1600000000,\n \"date_updated\": 1600000001,\n \"esigned\": false,\n \"is_active\": true,\n \"is_archived\": true,\n \"related\": [\n {\n \"id\": \"JOB_ID_123\",\n \"name\": \"John Doe / PROJECT-123\",\n \"number\": \"1000\",\n \"type\": \"job\",\n \"email\": null,\n \"subject\": null\n },\n {\n \"id\": \"CONTACT_ID_123\",\n \"name\": \"John Doe (CLIENT-123)\",\n \"number\": \"2000\",\n \"type\": \"contact\",\n \"email\": null,\n \"subject\": null\n }\n ],\n \"status\": 4,\n \"status_name\": \"Closed\",\n \"number\": \"INV-001\",\n \"location\": {\n \"id\": 1\n },\n \"subtotal\": 10000,\n \"margin\": 0,\n \"tax\": 0,\n \"total\": 10000,\n \"cost\": 10000,\n \"total_paid\": 10000,\n \"due\": 0,\n \"terms\": null,\n \"note\": \"\",\n \"date_due\": 1600000002,\n \"date_invoice\": 1600000003,\n \"date_status_change\": 1600000004,\n \"date_paid_in_full\": 1600000005,\n \"items\": [\n {\n \"quickbooksId\": \"1\",\n \"showGroupTotal\": null,\n \"addMarkup\": null,\n \"addMarkupIsExcluded\": null,\n \"photos\": [],\n \"jnid\": \"ITEM_ID_123\",\n \"name\": \"Service\",\n \"uom\": \"Items\",\n \"item_type\": \"material\",\n \"description\": \"John Doe / PROJECT-123 / SERVICE\",\n \"quantity\": 1,\n \"price\": 10000,\n \"preSurchargePrice\": null,\n \"cost\": 10000,\n \"amount\": 10000,\n \"tax_couch_id\": null,\n \"tax_name\": null,\n \"tax_rate\": 0,\n \"labor\": {\n \"quickbooksId\": null,\n \"price\": 0,\n \"preSurchargePrice\": null,\n \"cost\": 0,\n \"addMarkup\": null,\n \"addMarkupIsExcluded\": null,\n \"amount\": 0,\n \"tax_couch_id\": null,\n \"tax_name\": null,\n \"tax_rate\": 0\n },\n \"sku\": null,\n \"color\": null,\n \"category\": null\n }\n ],\n \"sections\": [],\n \"payments\": [],\n \"owners\": [\n {\n \"id\": \"OWNER_ID_123\"\n }\n ],\n \"sales_rep\": \"SALES_REP_ID_123\",\n \"sales_rep_name\": \"Jane Smith\",\n \"jnid\": \"INVOICE_ID_123\",\n \"internal_note\": \"\",\n \"template_id\": \"TEMPLATE_ID_123\",\n \"first_payment_date\": 1600000006,\n \"version\": null,\n \"duplicate_from_id\": null\n}\n\nThis request allows you to retrieve all of the invoices within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nQuery Parameters:
\nfrom: Starting index for pagination (e.g., 10)
size: Number of results to return (e.g., 5)
Response:
\nExample of a partial response:
\n{\n \"count\": 1000,\n \"results\": [\n {\n \"attachment_id\": \"attachmentjnid\",\n \"class_id\": null,\n \"class_name\": null,\n \"cost\": 10000,\n \"created_by\": \"system_qbo\",\n \"created_by_name\": \"QuickBooks\",\n \"customer\": \"customerjnid\",\n \"date_created\": 1600000000,\n \"date_due\": 1600000001,\n \"date_invoice\": 1600000002,\n \"date_paid_in_full\": 1600000003,\n \"date_status_change\": 1600000004,\n \"date_updated\": 1600000005,\n \"due\": 0,\n \"duplicate_from_id\": null,\n \"esigned\": false,\n \"external_id\": null,\n \"first_payment_date\": 1600000006,\n \"guid\": \"12345678-ABCD-1234-EFGH-1234567890AB\",\n \"internal_note\": \"\",\n \"is_active\": true,\n \"is_archived\": true,\n \"items\": [\n {\n \"amount\": 10000,\n \"cost\": 10000,\n \"description\": \"Sample Project / SAMPLE-ID / SERVICE\",\n \"item_type\": \"material\",\n \"jnid\": \"ITEM_ID_1\",\n \"labor\": {\n \"amount\": 0,\n \"cost\": 0,\n \"price\": 0,\n \"tax_rate\": 0\n },\n \"name\": \"Service\",\n \"price\": 10000,\n \"quantity\": 1,\n \"quickbooksId\": \"1\",\n \"tax_rate\": 0,\n \"uom\": \"Items\"\n }\n ],\n \"jnid\": \"INVOICE_ID_1\",\n \"location\": {\n \"id\": 1\n },\n \"margin\": 0,\n \"note\": \"\",\n \"number\": \"INV-001\",\n \"owners\": [\n {\n \"id\": \"OWNER_ID_1\"\n }\n ],\n \"payments\": [],\n \"recid\": 1000,\n \"related\": [\n {\n \"id\": \"JOB_ID_1\",\n \"name\": \"Sample Project / SAMPLE-ID\",\n \"number\": \"1000\",\n \"type\": \"job\"\n },\n {\n \"id\": \"CONTACT_ID_1\",\n \"name\": \"John Doe (SAMPLE-ID)\",\n \"number\": \"1001\",\n \"type\": \"contact\"\n }\n ],\n \"sales_rep\": \"salesrepjnid\",\n \"sales_rep_name\": \"Jane Smith\",\n \"sections\": [],\n \"status\": 4,\n \"status_name\": \"Closed\",\n \"subtotal\": 10000,\n \"supplier\": null,\n \"tax\": 0,\n \"template_id\": \"templatejnid\",\n \"terms\": null,\n \"total\": 10000,\n \"total_paid\": 10000,\n \"type\": \"invoice\",\n \"version\": null\n }\n ]\n}\n\nThe Invoice API endpoint allows you to create, view, and update an individual or group of Invoices within JobNimbus.
\n/v2/invoices\n\nhttps://app.jobnimbus.com/api1/v2/invoices\n\nThis request allows you to retrieve all of the work orders within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThis request allows you to create a payment within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nHTTP Status 500 = failure (most likely missing a required field)
\nAnything other status code = failure and will include an error message in the response
\nThe Payment API endpoint allows you to view Payments within JobNimbus.
\n/payments\n\nhttps://app.jobnimbus.com/api1/payments\n\nThis request allows you to retrieve all of the work orders within a JobNimbus account.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nThe Budget API endpoint allows you to view Budgets within JobNimbus.
\n/budgets\n\nhttps://app.jobnimbus.com/api1/budgets\n\nThis request allows you to retrieve the configuration of a JobNimbus account's settings.
\nResponse Codes:
\nResponse:
\n{\n \"workflows\": [\n {\n \"id\": 1,\n \"order\": 1,\n \"object_type\": \"contact\",\n \"name\": \"Customer\",\n \"is_sub_contractor\": false,\n \"is_supplier\": false,\n \"is_active\": true,\n \"can_access_by_all\": false,\n \"is_vendor\": false,\n \"icon\": null,\n \"status\": [\n {\n \"id\": 1,\n \"name\": \"Lead\",\n \"is_lead\": true,\n \"is_closed\": false,\n \"is_active\": true,\n \"is_archived\": false,\n \"send_to_quickbooks\": false,\n \"force_mobile_sync\": false,\n \"order\": 1,\n \"profile_ids\": [\n 0\n ]\n },....] \n },\n .....\n ],\n \"fileTypes\": [\n {\n \"FileTypeId\": 1,\n \"TypeName\": \"Document\",\n \"IsActive\": true\n },\n .....\n ],\n \"taskTypes\": [\n {\n \"TaskTypeId\": 1,\n \"TypeName\": \"Task\",\n \"DefaultName\": \"Task\",\n \"Icon\": \"\",\n \"HideFromTaskList\": false,\n \"HideFromCalendarView\": false,\n \"IsActive\": true\n },\n .....\n ],\n \"activityTypes\": [\n {\n \"ActivityTypeId\": 1,\n \"TypeName\": \"Note\",\n \"ShowInJobShare\": false,\n \"IsActive\": true\n },\n .....\n ],\n \"sources\": [\n {\n \"JobSourceId\": 1,\n \"SourceName\": \"Referral\",\n \"IsActive\": true\n },\n .....\n ]\n}\nThis request allows you to retrieve the configuration of a JobNimbus account's settings.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nResponse:
\nIf a field is passed then the API will return a value in that field from the customer object.
\nIf a field is null then see an example of the partial response below:
\n[\n {\n \"name\": \"Sales\",\n \"managers\": [\n \"managerid1\",\n \"managerid2\",\n \"managerid3\"\n ],\n \"members\": [ \n \"memberid1\",\n \"memberid2\",\n \"memberid3\"\n ]\n},\n...\n]\n\nThis request allows you to retrieve a list of an account's JobNimbus users.
\nResponse Codes:
\nResponse:
\nExample of a partial response:
\n{\n \"users\": [\n {\n \"first_name\": \"fname\",\n \"last_name\": \"lname\",\n \"image_url\": \"\",\n \"id\": \"abcdid\", // this is user's contact jnid\n \"calendar_color\": \"#2ECC71\",\n \"email\": \"abc@jobnimbus.com\",\n \"is_active\": true // whether user is active or disabled\n },....\n \"date_updated\": 1519413931 // last time when this document updated (user added, updated, modified)\n}\nThis request allows you to retrieve a list of Units of Measurement.
\nResponse Codes:
\nHTTP Status 200 = success
\nAnything other status code = failure and will include an error message in the response
\nResponse:
\nExample of a partial response:
\n[\n\"SQ\",\n\"UOM1\",...\n]\n\nThis 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.
\nResponse Codes:
\nResponse:
\nIf a workflow already exists, then the API endpoint will return with a response with the status for that workflow.\nIf the workflow didn't exist, then the API endpoint will return a response similar to the example, below:
\n{\n \"id\": 1,\n \"order\": 1,\n \"object_type\": \"contact\",\n \"name\": \"Customer\",\n \"is_sub_contractor\": false,\n \"is_supplier\": false,\n \"is_active\": true,\n \"can_access_by_all\": false,\n \"is_vendor\": false,\n \"icon\": null,\n \"status\": [\n {\n \"id\": 1,\n \"name\": \"Lead\",\n \"is_lead\": true,\n \"is_closed\": false,\n \"is_active\": true,\n \"is_archived\": false,\n \"send_to_quickbooks\": false,\n \"force_mobile_sync\": false,\n \"order\": 1,\n \"profile_ids\": [\n 0\n ]\n },....] \n },\n .....\n ]\n}\nThis 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.
\nResponse Codes:
\nResponse:
\nIf a workflow already exists, then the API endpoint will return with a response with the status for that workflow.\nIf the workflow didn't exist, then the API endpoint will return a response similar to the example, below:
\n{\n \"id\": 1,\n \"name\": \"Lead\",\n \"is_lead\": true,\n \"is_closed\": false,\n \"is_active\": true,\n \"is_archived\": false,\n \"send_to_quickbooks\": false,\n \"force_mobile_sync\": false,\n \"order\": 1,\n \"profile_ids\": [\n 0\n ]\n}\nThis 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.
\nResponse Codes:
\nResponse:
\nIf a workflow already exists, then the API endpoint will return with a response with the status for that workflow.\nIf the workflow didn't exist, then the API endpoint will return a response similar to the example, below:
\n{\n \"id\": 1,\n \"order\": 1,\n \"object_type\": \"contact\",\n \"name\": \"Customer\",\n \"is_sub_contractor\": false,\n \"is_supplier\": false,\n \"is_active\": true,\n \"can_access_by_all\": false,\n \"is_vendor\": false,\n \"icon\": null,\n \"status\": [\n {\n \"id\": 1,\n \"name\": \"Lead\",\n \"is_lead\": true,\n \"is_closed\": false,\n \"is_active\": true,\n \"is_archived\": false,\n \"send_to_quickbooks\": false,\n \"force_mobile_sync\": false,\n \"order\": 1,\n \"profile_ids\": [\n 0\n ]\n },....] \n },\n .....\n ]\n}\nThis 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.
\nResponse Codes:
\nResponse:
\nIf a custom field with that name already exists, then the API endpoint will return with a response with the status for that custom field.\nIf the custom field didn't exist, then the API endpoint will return a response similar to the example, below:
\n{\n \"title\": \"new2\",\n \"type\": \"string\",\n \"visible\": true,\n \"is_currency\": false,\n \"is_ddn\": true,\n \"is_required\": false,\n \"options\": [\n \"test\",\n \"test1\"\n ],\n \"field\": \"cf_string_7\"\n}\nThis 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.
\nResponse Codes:
\nResponse:
\nIf a file type with that name already exists, then the API endpoint will return with a response with the status for that file type.\nIf the file type didn't exist, then the API endpoint will return a response similar to the example, below:
\n{\n \"FileTypeId\": 895,\n \"TypeName\": \"Document\",\n \"IsActive\": true\n}\nThis 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.
\nResponse Codes:
\nResponse:
\nIf a task type with that name already exists, then the API endpoint will return with a response with the status for that task type.\nIf the task type didn't exist, then the API endpoint will return a response similar to the example, below:
\n{\n \"TaskTypeId\": 1469,\n \"TypeName\": \"Task\",\n \"DefaultName\": \"Task\",\n \"Icon\": null,\n \"HideFromTaskList\": false,\n \"HideFromCalendarView\": false,\n \"IsActive\": true\n}\nThis 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.
\nResponse Codes:
\nResponse:
\nIf an activity type with that name already exists, then the API endpoint will return with a response with the status for that activity type.\nIf the activity type didn't exist, then the API endpoint will return a response similar to the example, below:
\n{\n \"ActivityTypeId\": 1518,\n \"TypeName\": \"Note\",\n \"ShowInJobShare\": true,\n \"IsActive\": true\n}\nThis 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.
\nResponse Codes:
\nResponse:
\nIf a location with that name already exists, then the API endpoint will return with a response with the status for that location.\nIf the location didn't exist, then the API endpoint will return a response similar to the example, below:
\nEg1:\n{\n \"id\": 4,\n \"name\": \"Location Name\",\n \"is_active\": true,\n \"address_line1\": \"address1\",\n \"address_line2\": \"address2\",\n \"code\": \"HH\",\n \"city\": \"American Fork\",\n \"zip\": \"84004\",\n \"phone\": \"999-999-9999\"\n}\nEg2:\n{\n \"id\": 1,\n \"name\": \"HungryHead\",\n \"code\": \"HH\",\n \"address_line1\": \"102, sapetrshi apt\",\n \"address_line2\": \"sagrampura\",\n \"city\": \"Surat\",\n \"state_text\": \"Gujarat\",\n \"country_name\": \"India\",\n \"zip\": \"392002\",\n \"phone\": \"9033204250\",\n \"logo_id\": \"j5m9a0agbjnt3xvv\",\n \"header_color\": \"#c1cfd8\",\n \"is_active\": true,\n \"calendar\": {\n \"weekends\": true,\n \"start_day\": 0,\n \"business_hours\": {\n \"start\": 1502649000,\n \"end\": 1502734500\n }\n }\n}\nThe Account API endpoint allows you to view, create or edit settings within a JobNimbus account.
\n/account\n\n