Broadlume BMS

Version

Sections

Version
- GET
  API Version
Authentication
- POST
  Authenticate User / Create Session
- GET
  Session Keepalive
- DELETE
  Remove Session
- GET
  Session Count
- GET
  User permissions
- POST
  Change Branches
Order
- POST
  Create Order
- PATCH
  Update Order
- GET
  Get Order
- PATCH
  Update Order Line Installer (Single Date Only)
- GET
  Get Order Lines - Inactive until 2102 Release
- POST
  Create Order Line
- GET
  Sales Reps
- GET
  Order Type List
- GET
  Accumulator Code List
- GET
  Order Time Slot List
- GET
  Orders by date range
- GET
  Aging Invoices
- POST
  Create Order Line Comment
- PATCH
  Update Order Line Comment
- GET
  Get order line commments
- DELETE
  Delete order line commment
- POST
  Creates a Job Note
- PATCH
  Edits a Job Note
- GET
  Reads a Job Note
- DELETE
  Erases a Job Note
- GET
  List of Initials
- GET
  Job Status List
- GET
  Get Region Tax Codes
- GET
  Get Sales Rep Commission Details
- GET
  Tax Code Details
- GET
  Get ORDLSUB Records
Customer
- GET
  Customer List
- GET
  Customer info
- POST
  Customer info
- PATCH
  Customer info
- GET
  Customer Search
- GET
  Customer Search
- GET
  Customer Properties
- GET
  Customer Property Managers
- GET
  Customer Invoices
- GET
  Customer 5 Year Sales
- GET
  Customer AR Contacts
- POST
  Creates Customer Contact
- PATCH
  Updates Existing Customer Contact
- GET
  Customer AR Contact Notes
- POST
  Create Customer AR Contact Notes
- PATCH
  Update Customer AR Contact Notes
- GET
  All Customer Contact Notes
- GET
  Customer Sales
- GET
  Get Contact Role List
- GET
  Ship To Information
- GET
  Customer Ship To Codes
- GET
  Payment History
- GET
  AR Open Items
- GET
  Ship To Code List
- GET
  Get list of national property manager relationships
- POST
  Creates a Customer Note
- PATCH
  Edits a Customer Note
- GET
  Reads a Customer Note
- DELETE
  Erases a Customer Note
- POST
  Creates a Sales Note
- PATCH
  Edits a Sales Note
- GET
  Reads a Sales Note
- DELETE
  Erases a Sales Note
- POST
  Creates a Customer Note by ShipTo Code - Inactive until 2102 Release
- PATCH
  Updates a Customer Note by ShipTo Code - Inactive until 2102 Release
- GET
  Gets all Customer Note by ShipTo Code - Inactive until 2102 Release
- DELETE
  Erases a Customer Note by ShipTo Code - Inactive until 2102 Release
- GET
  Customer Search
- GET
  Get List of possible customer credit status codes
Company
- GET
  Company Info
- GET
  Branch info
- GET
  Branches list
- GET
  System Information
- GET
  Global settings
- GET
  Settings specific to a company
- GET
  Territory Codes List
Product
- GET
  Product types
- GET
  Product codes
- GET
  Product styles
- GET
  Product styles
- GET
  Product colors
- GET
  Product stock
- GET
  Product price
- GET
  Product Attributes
- GET
  Attributes Labels
- GET
  Web Products
- GET
  Product details
- GET
  Get Associated Products
- GET
  Catalog Items
- GET
  Get Catalog Attribute Collections
- GET
  Get Catalog Attribute Brands
- GET
  Get Catalog Attribute Sales Rep
- GET
  Get Catalog Attribute Inventory Types
- GET
  Get Catalog Attribute Customer
- GET
  Get Catalog Attribute Dates
- GET
  Get Selected Inventory Catalog Attribute
- GET
  Get Selected Catalog Attribute File 2
- GET
  Get Selected Catalog Attribute File 3
Retail Pricing
- GET
  Sample Pricing Data
Edocs
- GET
  Edocs List
- POST
  Edoc upload
- GET
  Edoc download
- GET
  Get Edoc types for user
Install
- GET
  Installers list
- GET
  Installer info
- GET
  Installer List
- GET
  Install List by date
- GET
  Generate Installer Invoice PDF
- GET
  Installations By Date
- POST
  Create Installation Record
- GET
  Get Installation Records
- GET
  Installation limits and capacities
Dashboard
- GET
  Sales Quicklist
- GET
  AR Quicklist
- GET
  AP Quicklist
- GET
  Inventory Valuation Quicklist
- GET
  Work in Process quicklist
- GET
  Fiscal Year Quicklist
Pivot
- GET
  AP Bucket Definitions
- GET
  AP by Bucket
- GET
  AR Bucket Definitions
- GET
  AR By Bucket
- GET
  Sales Volume by Date
- GET
  Inventory Valuation
Lead
- GET
  Lead Time Slots
- GET
  Leads list
- POST
  Creates Lead
- PATCH
  Update lead
- GET
  Lead detail
- POST
  Updates Lead Notes
- POST
  Updates Lead Quick Note
- POST
  Updates Lead Disp Style/Quantity Notes
- POST
  Updates Lead Dispo Notes
- GET
  Lead Nonqualified Categories
- PATCH
  Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead.
- GET
  Lead Zone Categories
- GET
  Subterritory Categories
- GET
  Lead Exception Categories
- GET
  Lead Office Notes Categories
- POST
  Create Lead Office Notes
- PATCH
  Update Lead Office Notes
- GET
  Lead Scheduling Categories
- GET
  Nonqualified Categories
- GET
  Lead Mat Type Categories
- GET
  Lead Appointments
- POST
  Create Lead Product Notes
- PATCH
  Updates Lead Product Notes
- GET
  Gets Lead Product Notes
- DELETE
  Deletes Lead Product Notes
- GET
  Get Lead Room
- POST
  Create Lead Room
- PATCH
  Update Lead Room
- DELETE
  Remove Lead Room
- GET
  Room File
- GET
  Get All Availability
- GET
  Get Lead Specials
- POST
  Converts an existing lead into a quote
Bundle
- POST
  Create Bundle(Job/Quote) Record
- PATCH
  Update Bundle(Job/Quote) Name by sequence
- GET
  Return Bundle(Job/Quote) Name by sequence
Quote
- GET
  Quotes by follow up date range
- POST
  Create Quote
- PATCH
  Update Quote
- GET
  Get Quote
- POST
  Create Quote Line
- GET
  Get quote lines
- PATCH
  Update Quote Line
- DELETE
  Delete Quote Line
- POST
  Create Quote Line Comment
- PATCH
  Update Quote Line Comment
- GET
  Get Quote line commments
- GET
  Reads a Quote Note
- GET
  Get QRDLSUB Records
Inventory
- GET
  Get Catalog Items below Safety Stock Limit
- GET
  Assigned Inventory Received
- GET
  Get Inventory Point records
- GET
  Get Inventory File Records
- GET
  Get Inventory Assigned on Job
- PATCH
  Unassign Inventory on Job
- POST
  Assign Inventory to Job
Invoice
- GET
  Invoice Header
- GET
  Get Invoice Lines
- GET
  Invoice download
- GET
  Get Invoice Commission Info
- GET
  Get Job Cost Info
Accounts Receivable
- GET
  AR Notes by Bucket
- GET
  Payment Type Codes
- GET
  AR Customer Register
- GET
  AR Customer Register History
Reports
- GET
  Get pre-built sales report
- GET
  Get written business report
- GET
  Get written business report detail
Audit
- GET
  Audit create record for order
- GET
  Audit create record for quote
General Ledger
- GET
  Get GL Chart of Accounts
- GET
  Get GL Report Format List
- GET
  Get GL Detail By Period
- GET
  Get GL Detail By Period
Handheld
- GET
  Inventory from barcode scan
- GET
  Inventory by location
- GET
  View A-J pricing
- GET
  Find PO's by barcode
- GET
  Find PO's by vendor that can have additional material added
- POST
  Create PO
- POST
  Create PO Line
- GET
  Get PO lines
- PATCH
  Update PO Line
- GET
  Read WO lines from barcode
- GET
  Read WO header from barcode
- PATCH
  Unassign Inventory
- POST
  Assign Inventory
- POST
  Ships Work Order
- GET
  Inventory Locations from barcode scan
- GET
  Get unpicked inventory
- GET
  Get inventory comments
- GET
  Find temporary inventory barcode.
- GET
  Get user barcode settings.
- GET
  Get staged revisions list
- GET
  Convert Inventory Quantity
Purchase Order
- PATCH
  Update PO
- GET
  Read purchase order lines that are open
- GET
  Purchase order detail
- GET
  List of purchase orders by date
- GET
  PO Shipvia
- GET
  PO Freight Terms
- GET
  PO Shipment Method of Payment
- GET
  Vendor Type List
- GET
  Customer Type List
- POST
  Creates a PO Note
- PATCH
  Edits a PO Note
- GET
  Reads PO Notes
- POST
  Create PO Line Comment
- GET
  Get PO line commments
- GET
  Get PO Pointers
- GET
  Get Purchase Order File Data - SQL Format
ChargeItPro
- GET
  ChargeItPro summary
Vendor
- GET
  Vendor Details
- GET
  Get Vendor Contacts
Committed
- GET
  Committed Inventory
General
- GET
  Get records from the customer, customer address, customer contacts, leads, and vendor records based on phone number.
- GET
  Get records for contacts created on or after date sent.
- GET
  Get web storage objects per user
- GET
  Get web storage objects per user
- POST
  Create webstorage object
- PATCH
  Update webstorage object
- DELETE
  Update webstorage object
Build Order
- GET
  Get BM File
- GET
  Get Build Order Lines File
- GET
  Get Build Order Point File
- GET
  Get Order-Related Build Order Lines
Logo
- GET
  Get Installer Logo
- GET
  Get Logo
- GET
  Get Logo settings bu document type