# Broadlume Customer API

**Canonical:** https://apis.io/apis/broadlume/broadlume-customer-api/  
**Provider:** Broadlume — https://apis.io/providers/broadlume/  
**Base URL:** https://api.rmaster.com/api  
**Documentation:** https://developer.broadlume.com/bms

Broadlume Customer API is one of 28 APIs that [Broadlume](https://apis.io/providers/broadlume/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The Customer API from Broadlume — 26 operation(s) for customer.

## Operations (39)

| Method | Path | Summary |
|---|---|---|
| GET | `/{alias}/customers` | Customer List |
| GET | `/{alias}/customer` | Customer info |
| POST | `/{alias}/customer` | Customer info |
| PATCH | `/{alias}/customer` | Customer info |
| GET | `/{alias}/customersearchbyphone` | Customer Search |
| GET | `/{alias}/customersearch` | Customer Search |
| GET | `/{alias}/customerproperties` | Customer Properties |
| GET | `/{alias}/customerpropertymanagers` | Customer Property Managers |
| GET | `/{alias}/customerinvoices` | Customer Invoices |
| GET | `/{alias}/customer5year` | Customer 5 Year Sales |
| GET | `/{alias}/customerARcontacts` | Customer AR Contacts |
| POST | `/{alias}/customercontact` | Creates Customer Contact |
| PATCH | `/{alias}/customercontact` | Updates Existing Customer Contact |
| GET | `/{alias}/customerARnotes` | Customer AR Contact Notes |
| POST | `/{alias}/ customerARnotes` | Create Customer AR Contact Notes |
| PATCH | `/{alias}/ customerARnotes` | Update Customer AR Contact Notes |
| GET | `/{alias}/ ContactNotesbyID` | All Customer Contact Notes |
| GET | `/{alias}/customersaleslist` | Customer Sales |
| GET | `/{alias}/roleList` | Get Contact Role List |
| GET | `/{alias}/shipto` | Ship To Information |
| GET | `/{alias}/customershiptos` | Customer Ship To Codes |
| GET | `/{alias}/payhist` | Payment History |
| GET | `/{alias}/aropenitem` | AR Open Items |
| GET | `/{alias}/shiptocodes` | Ship To Code List |
| GET | `/{alias}/nationalpropertymanagers` | Get list of national property manager relationships |
| POST | `/{alias}/customernotes` | Creates a Customer Note |
| PATCH | `/{alias}/customernotes` | Edits a Customer Note |
| GET | `/{alias}/customernotes` | Reads a Customer Note |
| DELETE | `/{alias}/customernotes` | Erases a Customer Note |
| POST | `/{alias}/salesnotes` | Creates a Sales Note |
| PATCH | `/{alias}/salesnotes` | Edits a Sales Note |
| GET | `/{alias}/salesnotes` | Reads a Sales Note |
| DELETE | `/{alias}/salesnotes` | Erases a Sales Note |
| POST | `/{alias}/shiptonotes` | Creates a Customer Note by ShipTo Code - Inactive until 2102 Release |
| PATCH | `/{alias}/shiptonotes` | Updates a Customer Note by ShipTo Code - Inactive until 2102 Release |
| GET | `/{alias}/shiptonotes` | Gets all Customer Note by ShipTo Code - Inactive until 2102 Release |
| DELETE | `/{alias}/shiptonotes` | Erases a Customer Note by ShipTo Code - Inactive until 2102 Release |
| GET | `/{alias}/customersearchbyemail` | Customer Search |
| GET | `/{alias}/customercreditstats` | Get List of possible customer credit status codes |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/openapi/broadlume-customer-api-openapi.yml
- **Documentation** — https://developer.broadlume.com/bms
- **APIReference** — https://developer.broadlume.com/bms
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/authentication/broadlume-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/conventions/broadlume-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/errors/broadlume-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/data-model/broadlume-data-model.yml
- **Console** — https://developer.broadlume.com/api-runner/broadlume/bms

## Other Broadlume APIs (12)

- [Broadlume Accounts Receivable API](https://apis.io/apis/broadlume/broadlume-accounts-receivable-api/)
- [Broadlume Audit API](https://apis.io/apis/broadlume/broadlume-audit-api/)
- [Broadlume Authentication API](https://apis.io/apis/broadlume/broadlume-authentication-api/)
- [Broadlume Build Order API](https://apis.io/apis/broadlume/broadlume-build-order-api/)
- [Broadlume Bundle API](https://apis.io/apis/broadlume/broadlume-bundle-api/)
- [Broadlume Charge It Pro API](https://apis.io/apis/broadlume/broadlume-chargeitpro-api/)
- [Broadlume Committed API](https://apis.io/apis/broadlume/broadlume-committed-api/)
- [Broadlume Company API](https://apis.io/apis/broadlume/broadlume-company-api/)
- [Broadlume Dashboard API](https://apis.io/apis/broadlume/broadlume-dashboard-api/)
- [Broadlume Edocs API](https://apis.io/apis/broadlume/broadlume-edocs-api/)
- [Broadlume General API](https://apis.io/apis/broadlume/broadlume-general-api/)
- [Broadlume General Ledger API](https://apis.io/apis/broadlume/broadlume-general-ledger-api/)

## Tags

Customers

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/broadlume/broadlume-customer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/broadlume/.