The JobNimbus connector lets your AI agent act in each user's JobNimbus account. Each user connects their own JobNimbus access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 34 tools.
- Tools
- 34
- What they doRead · write · destructive
- 23 · 11 · 023 read11 write0 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the JobNimbus connection
In AgentKit > Connections, create a JobNimbus connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'jobnimbus'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize JobNimbus:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'jobnimbus_get_account_settings',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "jobnimbus"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize JobNimbus:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="jobnimbus_get_account_settings",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their JobNimbus credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooljobnimbus_get_account_settingsRetrieve the JobNimbus account configuration, including contact, job, and work order workflows with their statuses, lead sources, task types, and custom fields.Read-onlyGet Account Settings
Retrieve the JobNimbus account configuration, including contact, job, and work order workflows with their statuses, lead sources, task types, and custom fields. Returns the settings object (or only the requested field). Use before create_contact or create_job to find valid workflow, status, and lead source names.
Inputs
fieldstring- Optional name of one settings section to return, for example groups. All settings are returned when omitted.
jobnimbus_get_activityRetrieve one JobNimbus activity entry (note or status change) by its jnid.Read-onlyGet Activity
Retrieve one JobNimbus activity entry (note or status change) by its jnid. Returns the activity record with note text, activity type, primary record, related records, and creator. Use when you have an activity jnid. Use list_activities to browse.
Inputs
activity_idstringrequired- The jnid (JobNimbus unique ID) of the activity.
jobnimbus_get_contactRetrieve one JobNimbus contact by its jnid.Read-onlyGet Contact
Retrieve one JobNimbus contact by its jnid. Returns the full contact record including names, phone numbers, address, workflow type, status, lead source, sales rep, owners, and custom fields. Use get_contact when you have a jnid. Use list_contacts to search or browse when you do not.
Inputs
contact_idstringrequired- The jnid (JobNimbus unique ID) of the contact.
jobnimbus_get_estimateRetrieve one legacy JobNimbus estimate by its jnid.Read-onlyGet Estimate
Retrieve one legacy JobNimbus estimate by its jnid. Returns the estimate record with number, dates, line items, totals, status, and related job or contact. Use when you have an estimate jnid. Use list_estimates to browse.
Inputs
estimate_idstringrequired- The jnid (JobNimbus unique ID) of the estimate.
jobnimbus_get_invoiceRetrieve one JobNimbus invoice by its jnid.Read-onlyGet Invoice
Retrieve one JobNimbus invoice by its jnid. Returns the invoice record with number, dates, line items, totals, status, and related job or contact. Use when you have an invoice jnid. Use list_invoices to browse.
Inputs
invoice_idstringrequired- The jnid (JobNimbus unique ID) of the invoice.
jobnimbus_get_jobRetrieve one JobNimbus job by its jnid.Read-onlyGet Job
Retrieve one JobNimbus job by its jnid. Returns the full job record including name, number, workflow type, status, address, sales rep, owners, related contacts, and custom fields. Use get_job when you have a jnid. Use list_jobs to search or browse when you do not.
Inputs
job_idstringrequired- The jnid (JobNimbus unique ID) of the job.
jobnimbus_get_material_orderRetrieve one JobNimbus material order by its jnid.Read-onlyGet Material Order
Retrieve one JobNimbus material order by its jnid. Returns the material order record with items, notes, owners, and related job or contact. Use when you have a material order jnid. Use list_material_orders to browse.
Inputs
material_order_idstringrequired- The jnid (JobNimbus unique ID) of the material order.
jobnimbus_get_productRetrieve one JobNimbus product by its jnid.Read-onlyGet Product
Retrieve one JobNimbus product by its jnid. Returns the product record with name, item type, tax status, and units of measure with cost and price. Use when you have a product jnid. Use list_products to browse.
Inputs
product_idstringrequired- The jnid (JobNimbus unique ID) of the product.
jobnimbus_get_taskRetrieve one JobNimbus task by its jnid.Read-onlyGet Task
Retrieve one JobNimbus task by its jnid. Returns the task record with title, task type, dates, priority, completion state, owners, and related records. Use get_task when you have a jnid. Use list_tasks to browse.
Inputs
task_idstringrequired- The jnid (JobNimbus unique ID) of the task.
jobnimbus_get_work_orderRetrieve one JobNimbus work order by its jnid.Read-onlyGet Work Order
Retrieve one JobNimbus work order by its jnid. Returns the work order record with number, status, line items, and related job or contact. Use when you have a work order jnid. Use list_work_orders to browse.
Inputs
work_order_idstringrequired- The jnid (JobNimbus unique ID) of the work order.
jobnimbus_list_activitiesList activity feed entries in JobNimbus such as notes and status changes, optionally filtered by a related contact or job.Read-onlyList Activities
List activity feed entries in JobNimbus such as notes and status changes, optionally filtered by a related contact or job. Returns a count and an activity array with jnid, note text, activity type, primary record, related records, and creator. Use to read the history of a contact or job. Use create_activity to add a note.
Inputs
fieldsstring- Comma-separated list of record fields to include in each result, which keeps responses small. All fields are returned when omitted.
filterstring- JSON filter in Elasticsearch query syntax, passed as a string. Example: {"must":[{"term":{"status_name":"Lead"}}]}. Use range on date_updated to find recent changes, or term on related.id to find records linked to a contact or job jnid.
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
sort_directionstring- Sort direction, asc or desc. The API uses desc when omitted.one of
ascdesc sort_fieldstring- Field to sort by, such as date_created or date_updated. The API sorts by date_created when omitted.
jobnimbus_list_contactsList contacts in JobNimbus, optionally filtered, sorted, or limited to chosen fields.Read-onlyList Contacts
List contacts in JobNimbus, optionally filtered, sorted, or limited to chosen fields. Returns a count and a results array of contact records with jnid, names, phone, email, address, workflow type, status, and sales rep. Use list_contacts to browse or filter many contacts. Use get_contact when you already have one contact jnid.
Inputs
fieldsstring- Comma-separated list of record fields to include in each result, which keeps responses small. All fields are returned when omitted.
filterstring- JSON filter in Elasticsearch query syntax, passed as a string. Example: {"must":[{"term":{"status_name":"Lead"}}]}. Use range on date_updated to find recent changes, or term on related.id to find records linked to a contact or job jnid.
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
sort_directionstring- Sort direction, asc or desc. The API uses desc when omitted.one of
ascdesc sort_fieldstring- Field to sort by, such as date_created or date_updated. The API sorts by date_created when omitted.
jobnimbus_list_estimatesList legacy estimates in JobNimbus.Read-onlyList Estimates
List legacy estimates in JobNimbus. Returns a count and a results array of estimates with jnid, number, dates, totals, status, and related job or contact. Use list_estimates to browse estimates. Use get_estimate for one estimate jnid.
Inputs
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
jobnimbus_list_filesList file attachment metadata in JobNimbus such as photos and documents.Read-onlyList Files
List file attachment metadata in JobNimbus such as photos and documents. Returns a count and a files array with jnid, filename, content type, size, and the related contact or job. File contents are not returned. Use to see which attachments exist on the account. File bytes cannot be downloaded with this tool.
Inputs
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
jobnimbus_list_invoicesList invoices in JobNimbus.Read-onlyList Invoices
List invoices in JobNimbus. Returns a count and a results array of invoices with jnid, number, dates, totals, status, and related job or contact. Use list_invoices to browse billing. Use get_invoice for one invoice jnid.
Inputs
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
jobnimbus_list_jobsList jobs in JobNimbus, optionally filtered, sorted, or limited to chosen fields.Read-onlyList Jobs
List jobs in JobNimbus, optionally filtered, sorted, or limited to chosen fields. Returns a count and a results array of job records with jnid, name, number, workflow type, status, address, and sales rep. Use list_jobs to browse or filter many jobs. Use get_job when you already have one job jnid.
Inputs
fieldsstring- Comma-separated list of record fields to include in each result, which keeps responses small. All fields are returned when omitted.
filterstring- JSON filter in Elasticsearch query syntax, passed as a string. Example: {"must":[{"term":{"status_name":"Lead"}}]}. Use range on date_updated to find recent changes, or term on related.id to find records linked to a contact or job jnid.
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
sort_directionstring- Sort direction, asc or desc. The API uses desc when omitted.one of
ascdesc sort_fieldstring- Field to sort by, such as date_created or date_updated. The API sorts by date_created when omitted.
jobnimbus_list_material_ordersList material orders in JobNimbus.Read-onlyList Material Orders
List material orders in JobNimbus. Returns the matching material order records with jnid, items, notes, and related job or contact. Use list_material_orders to browse. Use get_material_order for one jnid.
Inputs
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
jobnimbus_list_paymentsList payments recorded in JobNimbus.Read-onlyList Payments
List payments recorded in JobNimbus. Returns the matching payment records with amounts, dates, and related invoice, job, or contact. Use list_payments to review money received. Use list_invoices for what was billed.
Inputs
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
jobnimbus_list_productsList the product catalog items in JobNimbus.Read-onlyList Products
List the product catalog items in JobNimbus. Returns a count and a results array of products with jnid, name, item type, and units of measure with cost and price. Use list_products to browse the catalog. Use get_product for one product jnid.
Inputs
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
jobnimbus_list_tasksList tasks and calendar appointments in JobNimbus, optionally filtered or sorted.Read-onlyList Tasks
List tasks and calendar appointments in JobNimbus, optionally filtered or sorted. Returns a count and a results array of task records with jnid, title, task type, start and end dates, completion state, owners, and related contacts or jobs. Use list_tasks to browse. Use get_task for a single task jnid.
Inputs
fieldsstring- Comma-separated list of record fields to include in each result, which keeps responses small. All fields are returned when omitted.
filterstring- JSON filter in Elasticsearch query syntax, passed as a string. Example: {"must":[{"term":{"status_name":"Lead"}}]}. Use range on date_updated to find recent changes, or term on related.id to find records linked to a contact or job jnid.
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
sort_directionstring- Sort direction, asc or desc. The API uses desc when omitted.one of
ascdesc sort_fieldstring- Field to sort by, such as date_created or date_updated. The API sorts by date_created when omitted.
jobnimbus_list_uomsList the units of measure configured in the JobNimbus account.Read-onlyList Units of Measure
List the units of measure configured in the JobNimbus account. Returns an array of unit codes such as SQ. Use to find valid uom values when creating products, invoices, or line items.
Inputs
This tool takes no inputs.
jobnimbus_list_usersList the users (team members) of the JobNimbus account.Read-onlyList Users
List the users (team members) of the JobNimbus account. Returns a users array with id (the user jnid), name, email, calendar color, and active flag. Use to find user jnids for sales_rep, owner_ids, or task assignment.
Inputs
This tool takes no inputs.
jobnimbus_list_work_ordersList work orders in JobNimbus.Read-onlyList Work Orders
List work orders in JobNimbus. Returns the matching work order records with jnid, number, status, line items, and related job or contact. Use list_work_orders to browse. Use get_work_order for one work order jnid.
Inputs
offsetinteger- Zero-based index of the first record to return, used for paging. Pair with size, for example size 25 and offset 25 returns the second page.
sizeinteger- Maximum number of records to return (1-1000). The API returns up to 1000 records when omitted, so set a small value such as 25 to keep responses short.
jobnimbus_create_activityAdd a note activity to a JobNimbus contact or job.WriteCreate Activity
Add a note activity to a JobNimbus contact or job. Returns the created activity record including its jnid. Use to log a note against a contact or job. Use list_activities to read existing notes.
Inputs
notestringrequired- Text of the note.
primary_idstringrequired- The jnid of the contact or job the note is attached to. Sent as primary.id.
record_type_namestringrequired- Activity type name, usually Note.
date_createdinteger- Optional creation time as a Unix timestamp in seconds. Defaults to the current time.
jobnimbus_create_contactCreate a new contact in JobNimbus.WriteCreate Contact
Create a new contact in JobNimbus. Returns the created contact record including its new jnid. Use to add a customer or lead. Use update_contact to change an existing contact. Look up valid workflow and status names with get_account_settings first.
Inputs
record_type_namestringrequired- Name of the contact workflow the contact belongs to, such as Customer. It must match a contact workflow defined in the JobNimbus account (see get_account_settings).
status_namestringrequired- Status within the chosen workflow, such as Lead. It must exist in that workflow (see get_account_settings).
additional_fieldsobject- Extra fields to send on the contact, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"Claim Number": "124523-f"}.
address_line1string- Street address, first line.
address_line2string- Street address, second line such as an apartment or suite.
citystring- City.
companystring- Company name of the contact. A first name, last name, display name, or company is required on create.
country_namestring- Country name.
descriptionstring- Free-text description or notes for the contact.
display_namestring- Display name shown in JobNimbus. Use when you do not have separate first and last names.
emailstring- Email address of the contact.
first_namestring- Contact first name.
home_phonestring- Home phone number.
last_namestring- Contact last name.
mobile_phonestring- Mobile phone number.
sales_repstring- The jnid of the JobNimbus user assigned as sales rep. Use jobnimbus_list_users to find user IDs.
source_namestring- Lead source name. It must match a lead source defined in the JobNimbus account settings, for example Referral.
state_textstring- State or province, usually the two-letter code.
websitestring- Website of the contact or company.
work_phonestring- Work phone number.
zipstring- Postal or ZIP code.
jobnimbus_create_invoiceCreate an invoice on a JobNimbus job.WriteCreate Invoice
Create an invoice on a JobNimbus job. Returns the created invoice record including its jnid. Use to bill a job. Use update_invoice to change an existing invoice.
Inputs
itemsarrayrequired- Line items on the document. Each item has a name, description, uom (unit of measure such as Items), item_type (material or labor), quantity, and price. Example: [{"name": "Services", "description": "Shake siding", "uom": "Items", "item_type": "material", "quantity": 1, "price": 1303}].
job_idstringrequired- The jnid of the job the invoice belongs to. Sent as related[0] with type job.
additional_fieldsobject- Extra fields to send on the invoice, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"external_id": "993479"}.
date_dueinteger- Due date as a Unix timestamp in seconds.
date_invoiceinteger- Invoice date as a Unix timestamp in seconds.
internal_notestring- Internal note, not shown to the customer.
is_activeboolean- Set to false to archive (soft delete) the invoice.
numberstring- Invoice number shown to the customer.
statusinteger- Numeric invoice status code as used by JobNimbus, for example 1.
jobnimbus_create_jobCreate a new job in JobNimbus, usually linked to a contact.WriteCreate Job
Create a new job in JobNimbus, usually linked to a contact. Returns the created job record including its new jnid. Use to start a project for a customer. Use update_job to change an existing job. Look up valid workflow and status names with get_account_settings first.
Inputs
namestringrequired- Name of the job.
record_type_namestringrequired- Name of the job workflow the job belongs to. It must match a job workflow defined in the JobNimbus account (see get_account_settings).
status_namestringrequired- Status within the chosen workflow, such as Lead. It must exist in that workflow.
additional_fieldsobject- Extra fields to send on the job, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"Date of Loss": 1550692800}.
address_line1string- Job site street address, first line.
address_line2string- Job site street address, second line.
citystring- Job site city.
country_namestring- Job site country name.
descriptionstring- Free-text description of the job.
primary_contact_idstring- The jnid of the contact this job belongs to. It is sent as primary.id.
sales_repstring- The jnid of the JobNimbus user assigned as sales rep. Use list_users to find user IDs.
source_namestring- Lead source name. Must match a lead source defined in the account.
state_textstring- Job site state or province.
zipstring- Job site postal code.
jobnimbus_create_productCreate a product in the JobNimbus catalog.WriteCreate Product
Create a product in the JobNimbus catalog. Returns the created product record including its jnid. Use to add a catalog item used on estimates and invoices. Use update_product to change an existing one.
Inputs
namestringrequired- Product name. Keep it under 32 characters if the account syncs with QuickBooks.
descriptionstring- Product description.
is_activeboolean- Whether the product is active. Set to false to archive it.
item_typestring- Whether the product is material, labor, or both. It is always material unless labor and material is enabled in the account.one of
materiallaborlabor+material location_idinteger- ID of the account location the product belongs to.
tax_exemptboolean- Whether the product is exempt from tax.
uomsarray- List of units of measure the product is sold in. Each entry has a uom code (for example SQ, see list_uoms), and a material and/or labor object that each hold a cost and a price. Example: [{"uom": "SQ", "material": {"cost": 10, "price": 20}, "labor": {"cost": 5, "price": 10}}].
jobnimbus_create_taskCreate a task or calendar appointment in JobNimbus.WriteCreate Task
Create a task or calendar appointment in JobNimbus. Returns the created task record including its new jnid. Use to schedule follow-ups or appointments against a contact or job. Use update_task to reschedule or complete an existing task.
Inputs
date_startintegerrequired- Start time as a Unix timestamp in seconds.
record_type_namestringrequired- Name of the task type, such as Appointment or Task. It must match a task type defined in the JobNimbus account.
titlestringrequired- Title of the task.
additional_fieldsobject- Extra fields to send on the task, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"hide_from_tasklist": false}.
date_endinteger- End time as a Unix timestamp in seconds. Use 0 or omit for no end time.
descriptionstring- Longer description or notes for the task.
owner_idsarray- List of user jnids assigned to the task. Each is sent as owners[].id. Use list_users to find IDs.
priorityinteger- Task priority. 0 is the default priority.
related_idsarray- List of jnids of the contacts or jobs this task relates to. Each is sent as related[].id.
jobnimbus_update_contactUpdate fields on an existing JobNimbus contact, or archive it.WriteUpdate Contact
Update fields on an existing JobNimbus contact, or archive it. Returns the updated contact record. Use to change contact details, move it to another status, or set is_active to false to archive it. Use create_contact for new contacts.
- Idempotent
Inputs
contact_idstringrequired- The jnid (JobNimbus unique ID) of the contact to update.
additional_fieldsobject- Extra fields to send on the contact, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"Claim Number": "124523-f"}.
address_line1string- Street address, first line.
address_line2string- Street address, second line such as an apartment or suite.
citystring- City.
companystring- Company name of the contact. A first name, last name, display name, or company is required on create.
country_namestring- Country name.
descriptionstring- Free-text description or notes for the contact.
display_namestring- Display name shown in JobNimbus. Use when you do not have separate first and last names.
emailstring- Email address of the contact.
first_namestring- Contact first name.
home_phonestring- Home phone number.
is_activeboolean- Set to false to archive (soft delete) the contact. Set to true to restore it.
last_namestring- Contact last name.
mobile_phonestring- Mobile phone number.
record_type_namestring- Contact workflow name to move the contact to. Must match an existing contact workflow.
sales_repstring- The jnid of the JobNimbus user assigned as sales rep. Use jobnimbus_list_users to find user IDs.
source_namestring- Lead source name. It must match a lead source defined in the JobNimbus account settings, for example Referral.
state_textstring- State or province, usually the two-letter code.
status_namestring- New status within the contact workflow, such as Estimating.
websitestring- Website of the contact or company.
work_phonestring- Work phone number.
zipstring- Postal or ZIP code.
jobnimbus_update_invoiceUpdate an existing JobNimbus invoice, or archive it.WriteUpdate Invoice
Update an existing JobNimbus invoice, or archive it. Returns the updated invoice record. Use to change dates, notes, status, or line items on an invoice you already have. Use create_invoice for new invoices.
- Idempotent
Inputs
invoice_idstringrequired- The jnid (JobNimbus unique ID) of the invoice to update.
additional_fieldsobject- Extra fields to send on the invoice, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"external_id": "993479"}.
date_dueinteger- Due date as a Unix timestamp in seconds.
date_invoiceinteger- Invoice date as a Unix timestamp in seconds.
internal_notestring- Internal note, not shown to the customer.
is_activeboolean- Set to false to archive (soft delete) the invoice.
itemsarray- Line items on the document. Each item has a name, description, uom (unit of measure such as Items), item_type (material or labor), quantity, and price. Example: [{"name": "Services", "description": "Shake siding", "uom": "Items", "item_type": "material", "quantity": 1, "price": 1303}].
numberstring- Invoice number shown to the customer.
statusinteger- Numeric invoice status code as used by JobNimbus, for example 1.
jobnimbus_update_jobUpdate fields on an existing JobNimbus job, or archive it.WriteUpdate Job
Update fields on an existing JobNimbus job, or archive it. Returns the updated job record. Use to rename a job, change its status, reassign the sales rep, or set is_active to false to archive it. Use create_job for new jobs.
- Idempotent
Inputs
job_idstringrequired- The jnid (JobNimbus unique ID) of the job to update.
additional_fieldsobject- Extra fields to send on the job, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"Date of Loss": 1550692800}.
address_line1string- Job site street address, first line.
address_line2string- Job site street address, second line.
citystring- Job site city.
country_namestring- Job site country name.
descriptionstring- Free-text description of the job.
is_activeboolean- Set to false to archive (soft delete) the job. Set to true to restore it.
namestring- Name of the job.
primary_contact_idstring- The jnid of the contact this job belongs to. It is sent as primary.id.
record_type_namestring- Job workflow name to move the job to. Must match an existing job workflow.
sales_repstring- The jnid of the JobNimbus user assigned as sales rep. Use list_users to find user IDs.
source_namestring- Lead source name. Must match a lead source defined in the account.
state_textstring- Job site state or province.
status_namestring- New status within the job workflow, such as Estimating.
zipstring- Job site postal code.
jobnimbus_update_productUpdate an existing product in the JobNimbus catalog, or archive it.WriteUpdate Product
Update an existing product in the JobNimbus catalog, or archive it. Returns the updated product record. Use to change price, units of measure, or other details, or set is_active to false to archive. Use create_product for new products.
- Idempotent
Inputs
product_idstringrequired- The jnid (JobNimbus unique ID) of the product to update.
descriptionstring- Product description.
is_activeboolean- Whether the product is active. Set to false to archive it.
item_typestring- Whether the product is material, labor, or both. It is always material unless labor and material is enabled in the account.one of
materiallaborlabor+material location_idinteger- ID of the account location the product belongs to.
namestring- Product name. Keep it under 32 characters if the account syncs with QuickBooks.
tax_exemptboolean- Whether the product is exempt from tax.
uomsarray- List of units of measure the product is sold in. Each entry has a uom code (for example SQ, see list_uoms), and a material and/or labor object that each hold a cost and a price. Example: [{"uom": "SQ", "material": {"cost": 10, "price": 20}, "labor": {"cost": 5, "price": 10}}].
jobnimbus_update_taskUpdate an existing JobNimbus task, for example to reschedule, reassign, complete, or archive it.WriteUpdate Task
Update an existing JobNimbus task, for example to reschedule, reassign, complete, or archive it. Returns the updated task record. Use to change fields on a task you already have. Use create_task for new tasks.
- Idempotent
Inputs
task_idstringrequired- The jnid (JobNimbus unique ID) of the task to update.
additional_fieldsobject- Extra fields to send on the task, as a JSON object of field name to value. Use this for custom fields (by their label in JobNimbus, for example Claim Number) and for any other field the JobNimbus API accepts that is not listed above. Example: {"hide_from_tasklist": false}.
date_endinteger- End time as a Unix timestamp in seconds. Use 0 or omit for no end time.
date_startinteger- New start time as a Unix timestamp in seconds.
descriptionstring- Longer description or notes for the task.
is_activeboolean- Set to false to archive (soft delete) the task.
is_completedboolean- Set to true to mark the task completed.
owner_idsarray- List of user jnids assigned to the task. Each is sent as owners[].id. Use list_users to find IDs.
priorityinteger- Task priority. 0 is the default priority.
record_type_namestring- Task type name to change to. Must match an existing task type.
related_idsarray- List of jnids of the contacts or jobs this task relates to. Each is sent as related[].id.
titlestring- New title of the task.
No tools match.
