JobBOSS² Public API
The JobBOSS²-specific REST API for cloud-hosted JobBOSS² customers, covering orders and order line items, order routings, quotes and quote line items, customers, contacts, shipping addresses, estimates and part master, materials and material issues, time tickets, employees and vendors. Uses bearer tokens from the Integration Engine OAuth 2.0 client-credentials flow, take/skip paging, fields/filter/sort expressions, and a Title/Status/Detail/TraceId JSON error envelope.
Operations 142
POST
/api/v1/eci-aps/authenticate-user
GET
/api/v1/eci-aps/get-schedule
POST
/api/v1/shopview/authenticate-user
GET
/api/v1/shopview/filters
GET
/api/v1/shopview/get-jobs
POST
/api/v1/shopview/grid-option
GET
/api/v1/shopview/grid-options
GET
/api/v1/shopview/kpi-definitions
GET
/api/v1/shopview/kpi/jobs-closed
GET
/api/v1/shopview/kpi/jobs-in-progress
GET
/api/v1/shopview/kpi/jobs-on-hold
GET
/api/v1/shopview/kpi/jobs-past-due
POST
/api/v1/shopview/reset-grid-options
GET
/api/v1/ap-checks
Gets a list of AP Checks
POST
/api/v1/ap-checks
Creates a new AP Check
GET
/api/v1/ap-checks/{checkNumber}
Gets a single AP Check by check number
GET
/api/v1/ar-invoice-details
Gets a list of AR Invoice Details
GET
/api/v1/ar-invoices
Gets a list of AR Invoices
GET
/api/v1/attendance-ticket-details
Gets a list of Attendance Ticket Details
PATCH
/api/v1/attendance-ticket-details/{id}
Updates an Attendance Ticket Detail
POST
/api/v1/attendance-tickets/{ticketDate}/employees/{employeeCode}/attendance-ticket-details
Creates an Attendance Ticket Detail
GET
/api/v1/attendance-tickets
Gets a list of Attendance Tickets
POST
/api/v1/attendance-tickets
Creates an Attendance Ticket
GET
/api/v1/attendance-tickets/{ticketDate}/employees/{employeeCode}
Gets an Attendance Ticket by its unique ID
POST
/api/v1/oauth2Exchange
GET
/api/v1/bin-locations
Gets a list of Bin Locations
GET
/api/v1/company
Gets a company
GET
/api/v1/company-calendars
Gets a list of Company Calendars
GET
/api/v1/contacts
Gets a list of Contacts
POST
/api/v1/contacts
Creates a Contact
GET
/api/v1/contacts/{object}/{contactCode}/{contact}
Gets a Contact by specifying the object, the contact code and the contact
PATCH
/api/v1/contacts/{object}/{contactCode}/{contact}
Updates a Contact
GET
/api/v1/corrective-preventive-actions
Gets a list of corrective actions
GET
/api/v1/corrective-preventive-actions/{correctiveActionNumber}
Gets a corrective action by number
GET
/api/v1/currency-codes
Gets a list of Currency Codes
GET
/api/v1/customer-return-line-items
Gets a list of Customer Return Line Items
GET
/api/v1/customer-return-releases
Gets a list of Customer Return Releases
GET
/api/v1/customer-returns
Gets a list of Customer Returns
GET
/api/v1/customers
Gets a list of Customers
POST
/api/v1/customers
Creates a Customer
GET
/api/v1/customers/{customerCode}
Gets a Customer by customer code
PATCH
/api/v1/customers/{customerCode}
Updates a Customer
GET
/api/v1/departments
Gets a list of Departments
GET
/api/v1/document-controls
Gets a list of Document Controls
GET
/api/v1/document-histories
Gets a list of Document Histories
GET
/api/v1/document-review
Gets a list of Document Review records
GET
/api/v1/employee-trainings
Gets a list of Employee Trainings
GET
/api/v1/employees
Gets a list of Employees
PATCH
/api/v1/employees/{employeeCode}
Updates an Employee
GET
/api/v1/estimates
Gets a list of Estimates
POST
/api/v1/estimates
Creates an Estimate.
GET
/api/v1/estimates/{partNumber}
Gets an Estimate by part number
PATCH
/api/v1/estimates/{partNumber}
Updates an Estimate
GET
/api/v1/feedback
Gets a list of Feedback
GET
/api/v1/gl-codes
Gets a list of GL Codes
GET
/api/v1/gl-codes/{GLAccountNumber}
Gets a GL Code by GL Account Number
GET
/api/v1/issuing-materials/bin-locations
Gets a list of parts with bin locations and quantity on hand
GET
/api/v1/issuing-materials/job-numbers
Gets a list of job numbers
GET
/api/v1/issuing-materials/routing-steps
Gets a list of routing steps for jobs
POST
/api/v1/issuing-materials/stock-to-job-transfer
Transfer stock materials to a job
GET
/api/v1/job-materials
Gets a list of Job Materials
GET
/api/v1/job-materials/{uniqueID}
Gets a Job Material by unique ID
GET
/api/v1/job-requirements
Gets a list of Job Requirements
GET
/api/v1/job-requirements/{uniqueID}
Gets a Job Requirement by uniqueID
GET
/api/v1/estimates/{partNumber}/materials/{subPartNumber}
Gets a Material of an Estimate by part number and sub part number
GET
/api/v1/materials
Gets a list of Materials
GET
/api/v1/non-conformances
Gets a list of Non-Conformances
GET
/api/v1/non-conformances/{ncNumber}
Gets Non-Conformance by number
GET
/api/v1/operation-codes
Gets a list of Operation Codes
GET
/api/v1/operation-codes/{operationCode}
Gets an Operation Code by operation code
GET
/api/v1/order-line-items
Gets a list of Order Line Items
POST
/api/v1/orders/{orderNumber}/order-line-items
Creates an order line item.
GET
/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}
Gets an Order Line Item by Order's order number and Order Line Item's item number
PATCH
/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}
Updates an Order Line Item
GET
/api/v1/order-routings
Gets a list of Order Routings
POST
/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/order-routings
Creates an Order Routing
GET
/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/order-routings/{stepNumber}
Gets an order routing by order number and order routing's item number and order routing's step number
PATCH
/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/order-routings/{stepNumber}
Updates an Order Routing
GET
/api/v1/orders
Gets a list of Orders
POST
/api/v1/orders
Creates an Order
GET
/api/v1/orders/{orderNumber}
Gets an Order by order number
PATCH
/api/v1/orders/{orderNumber}
Updates an Order
GET
/api/v1/packing-list-line-items
Gets a list of Packing List Line Items
GET
/api/v1/packing-lists
Gets a list of Packing Lists
GET
/api/v1/product-codes
Gets a list of Product Codes
GET
/api/v1/product-codes/{productCode}
Gets a Product Code by specifying the productCode
GET
/api/v1/purchase-order-line-items
Gets a list of Purchase Order Line Items
PATCH
/api/v1/purchase-order-line-items/{purchaseOrderNumber}/{partNumber}/{itemNumber}
Updates a Purchase Order Line Item
GET
/api/v1/purchase-order-releases
Gets a list of Purchase Order Releases
GET
/api/v1/purchase-orders
Gets a list of Purchase Orders
GET
/api/v1/purchase-orders/{PONumber}
Gets a Purchase Order by PO number
PATCH
/api/v1/purchase-orders/{PONumber}
Updates a Purchase Order
GET
/api/v1/quote-line-items
Gets a list of Quote Line Items
GET
/api/v1/quotes/{quoteNumber}/quote-line-item/{itemNumber}
Gets a Quote Line Item
POST
/api/v1/quotes/{quoteNumber}/quote-line-items
Creates a Quote Line Item
PATCH
/api/v1/quotes/{quoteNumber}/quote-line-items/{itemNumber}
Updates a Quote Line Item
GET
/api/v1/quotes
Gets a list of Quotes
POST
/api/v1/quotes
Creates a Quote
GET
/api/v1/quotes/{quoteNumber}
Gets a Quote by order number
PATCH
/api/v1/quotes/{quoteNumber}
Updates a Quote
GET
/api/v1/reason-codes
Gets a list of Reason Codes
GET
/api/v1/reason-codes/{uniqueID}
Gets an reason code by uniqueID
POST
/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/releases
Creates a Order Release
GET
/api/v1/orders/{orderNumber}/order-line-items/{itemNumber}/releases/{uniqueID}
Gets an Order Release from an order by Order Number, Item Number and Unique ID
GET
/api/v1/releases
Gets a list of Releases
POST
/api/v1/reports
GET
/api/v1/reports/{requestId}
GET
/api/v1/estimates/{partNumber}/routings/{stepNumber}
Gets a Routing by estimate's part number and routing's step number
GET
/api/v1/routings
Gets a list of Routings
GET
/api/v1/salespersons
Gets a list of Salespersons
PATCH
/api/v1/salespersons/{salesID}
Updates a Salesperson
GET
/api/v1/shipping-addresses
Gets a list of Shipping Addresses
POST
/api/v1/shipping-addresses
Creates a Shipping Address
GET
/api/v1/shipping-addresses/{customerCode}/{location}
Gets a Shipping Address by customer code and location
PATCH
/api/v1/shipping-addresses/{customerCode}/{location}
Updates a Shipping Address
GET
/api/v1/tax-codes
Gets a list of Tax Codes
GET
/api/v1/tax-codes/{taxCode}
Gets an Tax Code by tax code
GET
/api/v1/terms
Gets a list of Terms Code
GET
/api/v1/terms/{termsCode}
Gets a Terms Code Order by Term Code
GET
/api/v1/time-ticket-details
Gets a list of Time Ticket Details
POST
/api/v1/time-ticket-details
Creates a Time Ticket Detail
GET
/api/v1/time-ticket-details/{timeTicketGUID}
Gets a Time Ticket Detail by timeTicketGUID
PATCH
/api/v1/time-ticket-details/{timeTicketGUID}
Updates a Time Ticket Detail
GET
/api/v1/time-tickets
Gets a list of Time Tickets
POST
/api/v1/time-tickets
Creates a Time Ticket
GET
/api/v1/time-tickets/{ticketDate}/employees/{employeeCode}
Gets a Time Ticket by its unique ID
PATCH
/api/v1/time-tickets/{ticketDate}/employees/{employeeCode}
Updates a time ticket
GET
/api/v1/tooling-maintenance
Gets a list of Tooling Maintenance Records
GET
/api/v1/user-labels
Gets a list of User Labels
GET
/api/v1/user-transactions
Gets a list of User Transaction records
GET
/api/v1/vendor-returns
Gets a list of Vendor Return records
GET
/api/v1/vendor-returns-line-items
Gets a list of Vendor Return Line Item records
GET
/api/v1/vendor-returns-releases
Gets a list of Vendor Return Release records
GET
/api/v1/vendors
Gets a list of Vendors
POST
/api/v1/vendors
Creates a Vendor
GET
/api/v1/vendors/{vendorCode}
Gets a Vendor by vendor code
PATCH
/api/v1/vendors/{vendorCode}
Updates a Vendor
GET
/api/v1/work-center-maintenance
Gets a list of Work Center Maintenance records
GET
/api/v1/work-centers
Gets a list of Work Centers
POST
/api/v1/work-centers
Creates a Work Center
GET
/api/v1/work-centers/{workCenter}
Gets a Work Center by work center code
PATCH
/api/v1/work-centers/{workCenter}
Updates a Work Center