What is RFMS API?
RFMS utilizes REST API protocol to provide our customers with API methods for creating and editing customers and leads in the RFMS database.
General methods currently available through the API:
- Create and update Customers*
- Find Customers
- Get Customers (using their unique Customer ID)
- Create Quote, Order and BidPro Estimate headers to serve as sales opportunities. These quotes and estimates do not include line items, but Internal Notes can be inserted.*
*Support for duplicate customer detection is included
See our API documentation that contains a list of the available methods and a description of the overall API design.
Are there different levels of API access?
Yes. The tiers of API coincide with the tier subscription of the ERP software. The basic tier overview is:
- If you have a Core ERP tier subscription, then you have access to the Standard tier of API.
- Capabilities include: CRM
- If you have a Professional ERP tier subscription, then you have access to the Plus tier of API.
- Capabilities include: CRM, Workflow Tools, Scheduling Apps, Payment Processors
- If you have an Enterprise ERP tier subscription, then you have access to the Enterprise tier of API.
- Capabilities include: All of the above plus Order Management and Inventory Management
For more details please see the table under API Tiers and Features below.
| API Features | Standard | Plus | Enterprise |
|---|---|---|---|
| Create Customer | |||
| Edit Customer | |||
| Search Customers | |||
| Get Customer | |||
| Create opportunities (quote, estimate, order header) | |||
| Get quotes and orders (headers and lines) | |||
| Update header info of quotes/orders (no editing of line items) | |||
| Post a payment to an order (not process) | |||
| Search for and get product information | |||
| Search for quotes and orders | |||
| Search for and get inventory information | |||
| Create claim headers | |||
| Export quotes to an order | |||
| Get/add attachments | |||
| Create orders (headers and lines) | |||
| Manage/edit orders (headers and lines) | |||
| Assign inventory to orders |
How can I start using the API?
Access to RFMS API is included with a subscription to the RFMS ERP software.
Installation of the "RFMS MOE API" Service is required. If you already use RFMS Mobile, RFMS Cloud Link or are a Podium customer that is using the RFMS integration, then you already have this service installed. If not, our technical team will help you with the installation when you sign up for the RFMS API along with the API Server Setup. Please contact your Client Success Manager for more information regarding the purchase of this subscription.
Once you purchase and the API service is installed, you should provide the following information to your own developer so that they can begin developing against our API:
1. Documentation for the Standard API
2. Unique API Credentials for your account and RFMS database. A developer will need the following two pieces of data in order to interact with your particular database:
- Store Queue Value
- API Token
Please see the article Generate API Credentials for Developers for more information on how to obtain these.
What If I don't have access to my own developer?
We are also available on Zapier, the leading API bridge between mainstream software applications. See the article that explains our Zapier.
Comments
0 comments
Please sign in to leave a comment.