{"info":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","description":"

Access your RFMS Business Management System data within your own application using a standard REST API.

\n
Note that we do not consider adding keys to response objects a breaking change, so the shape of objects may change without notice. However, existing keys will not be changed nor removed without notice.
\n

Standard Response

Calling a method for results always returns a structure like this:

{\n  \"status\": \"success\",\n  \"result\": {}\n}\n\n

status indicates whether or not the store has replied. A value of \"success\" means it has and the results are included as the \"result\" element. A value of \"waiting\" means the message response has not yet arrived. Finally, \"failed\" means the database rejected the request, a reason will be included as the result.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Standard Response","slug":"standard-response"}],"owner":"1121769","collectionId":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","publishedId":"SVYxovrh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-08-20T17:59:31.000Z"},"item":[{"name":"Authentication","item":[{"name":"Begin a new session","event":[{"listen":"test","script":{"id":"e12456f5-270f-4542-9651-1f4bd9dd3e19","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"sessionkey\", jsonData.sessionToken);\r","postman.setEnvironmentVariable(\"sessionExp\", jsonData.sessionExpires);\r","\r","tests[\"Status code is 200\"] = responseCode.code === 200;\r","tests[\"Authorized is true\"] = jsonData.authorized;\r",""],"type":"text/javascript"}}],"id":"10b3bfa3-dd57-45c0-a129-555143af319c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":"{{apikey}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.rfms.online/v2/session/begin","description":"

Request a session token to be used by all other API methods. This method has no parameters. Instead, use Basic Auth using your Store API Credentials, provided by RFMS support when you subscribe to the service.

If you have a Third Party Developer (TPD) agreement with RFMS, this method works a bit differently to allow you to specify which store you are requesting the session for. Normally, this method accepts a store-queue as user and API key as password. However, when called by the TPD they will instead use the following as their Basic Auth credentials:

Username: {rfmsBusId}@{TPD ID}\nPassword {their TPD password}

If the member store has granted access to you, the TPD, this method returns an access token that can then be used normally. The API will function in the same manner as if the session/begin method were called with a regular store API token. The token will be granted Plus level access regardless of the store’s actual API subscription level.

\n","urlObject":{"protocol":"https","path":["v2","session","begin"],"host":["api","rfms","online"],"query":[{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"79a966d4-8dc5-4d53-be84-36069bbe693e","name":"Begin a new session","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.rfms.online/v1/session/begin"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"authorized\": true,\n\t\"sessionToken\": \"1598c4a37c1c54552732bb907013176d\",\n\t\"sessionExpires\": \"3/5/2018 7:00:39 PM +00:00\"\n}"}],"_postman_id":"10b3bfa3-dd57-45c0-a129-555143af319c"},{"name":"Request Bus ID","event":[{"listen":"test","script":{"id":"247b8bc6-427d-41c7-803b-d0b9a3531488","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");","});","","var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"customerId\", jsonData.result[0].customerId);"],"type":"text/javascript"}}],"id":"8c1e181d-b9a4-4744-8196-19e38e9eb9a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"rfmsBusId\": 99999,\r\n \"reason\": \"PRACTICE: To provide access to TPD's App\"\r\n}"},"url":"https://api.rfms.online/v2/session/request","description":"

Before a TPD can access data at a member store, the store must opt-in to sharing their data with the TPD. This API method allows the TPD to request opt-in for one or more stores.

When calling this method, the TPD should use their provided ID and password as credentials using Basic Auth. They also POST the JSON values shown below.

The rfmsBusId is an integer value commonly known as the RFMS Business ID that the TPD is expected to already have and identifies the company. The text in the \"reason\" parameter will be displayed to the member store when they are asked to opt-in to allowing this access to their data.

All API methods require a session token. The session token authorizes access to your store database as well as identifying a specific user at your store the API methods should impersonate.

To acquire a session token, first sign into RFMS Online Services and open the \"RFMS Online\" section. Then, press the API button in the toolbar to generate or view your Store API Credentials. Call the \"Begin session\" method (below) with those credentials using HTTP Basic Auth to generate a session token. Use the entire Store Queue as the Username and the API Key as the Password. The session token can be used for a limited time. It will expire automatically but is extended each time a method is called.

The session token must be sent with all API requests as the password using HTTP Basic Auth. User name should be set using the same user name you used in the first step.

\n","event":[{"listen":"prerequest","script":{"id":"6e819dd2-d6ef-4841-9b62-10f5ce506de9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"986baf33-b85c-42c6-b25b-462daf02b5ec","type":"text/javascript","exec":[""]}}],"_postman_id":"06b86381-10c7-42e2-afda-61535b7c0b56","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}}},{"name":"Customers","item":[{"name":"Find Customers","event":[{"listen":"test","script":{"id":"247b8bc6-427d-41c7-803b-d0b9a3531488","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");","});","","var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"customerId\", jsonData.result[0].customerId);"],"type":"text/javascript"}}],"id":"c35b21c5-9c74-41ed-aedd-87146d0e5a67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"searchText\": \"blackmore\",\n \"includeCustomers\": \"true\",\n \"includeProspects\": \"false\",\n \"includeInactive\": \"false\"\n}"},"url":"https://api.rfms.online/v2/customers/find","description":"

Search for customers

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Meaning
searchText	true	The supplied text will be found in customer and ship-to name, address, phone, email address and city
includeCustomers	false	Search customers (true by default)
includeProspects	false	Search prospects (true by default)
includeInactive	false	Include inactive customers (false by default)
startIndex	false	Results are returned 10 at a time. If this value is omitted the first 10 are returned (Index numbers 0 to 9). To request the next 10, send startIndex = 10, etc.
referralType	false	For users that have the proper parameter set, setting this value to \"member\" will display customer search results with an association to Main only, while a \"client\" input will display results with association to a Branch only

Search for customers.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
searchText	String value. Text found in customer name.
stores	List of integers.
salespersonName	String value.
activeOnly	Boolean value. `true` value filters out inactive customers.
dateCreatedFrom	String in YYYY-MM-DD format
dateCreatedTo	String in YYYY-MM-DD format
lastPurchaseFrom	String in YYYY-MM-DD format
lastPurchaseTo	String in YYYY-MM-DD format
customerTypes	List of string values. Obtain from Get Customer Values endpoint.
businessSoldName	String value.
businessShipName	String value.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","customers","find","advanced"],"host":["api","rfms","online"],"query":[],"variable":[]}},"response":[{"id":"b5874dc8-67ad-4d4e-b9b2-9e6e877a00e0","name":"Advanced Customers Find","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"searchText\": \"car\",\r\n \"stores\": [32, 50],\r\n \"activeOnly\": false,\r\n \"dateCreatedFrom\": \"01-01-2021\",\r\n \"customerTypes\": [\"Commercial\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/customers/find/advanced"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"7675"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": [\n {\n \"phone3\": \"\",\n \"contact1\": \"MAX ERNST\",\n \"contact2\": \"\",\n \"active\": true,\n \"dateCreated\": \"2021-03-23T15:12:50\",\n \"createdBy\": \"kwilson\",\n \"dateUpdated\": \"2023-10-30T10:39:44\",\n \"updatedBy\": \"CBanuelos\",\n \"customerId\": 75688,\n \"customerAddress\": {\n \"businessName\": \"BANUELOS LLC\",\n \"lastName\": \"BANUELOS2\",\n \"firstName\": \"CARLTON\",\n \"address1\": \"123 Apple Rd\",\n \"address2\": \"\",\n \"city\": \"AKRON\",\n \"state\": \"AL\",\n \"postalCode\": \"35441\",\n \"county\": \"HALE\",\n \"country\": null\n },\n \"shipToAddress\": {\n \"businessName\": \"BANUELOS LLC\",\n \"lastName\": \"BANUELOS2\",\n \"firstName\": \"CARLTON\",\n \"address1\": \"14 INDUSTRIAL WAY\",\n \"address2\": \"STE 23\",\n \"city\": \"AKRON\",\n \"state\": \"AL\",\n \"postalCode\": \"35441\",\n \"county\": \"HALE\",\n \"country\": null\n },\n \"customerType\": \"COMMERCIAL\",\n \"entryType\": \"Customer\",\n \"phone1\": \"2052062071\",\n \"phone2\": \"\",\n \"email\": \"cbanllc@banllc.com\",\n \"preferredSalesperson1\": \"KAY SAGE\",\n \"preferredSalesperson2\": \"\",\n \"storeNumber\": 50,\n \"referralType\": \"Standalone\",\n \"referralMemberId\": 0,\n \"referralMemberName\": \"\"\n },\n {\n \"phone3\": \"\",\n \"contact1\": \"FIRST CONTACT\",\n \"contact2\": \"\",\n \"active\": true,\n \"dateCreated\": \"2021-04-08T10:53:53\",\n \"createdBy\": \"CBanuelos\",\n \"dateUpdated\": \"2021-04-08T10:53:53\",\n \"updatedBy\": \"CBanuelos\",\n \"customerId\": 75693,\n \"customerAddress\": {\n \"businessName\": \"ODYSSEY INC\",\n \"lastName\": \"HOMER\",\n \"firstName\": \"SIMPSON\",\n \"address1\": \"1222 NE SW North Blvd\",\n \"address2\": \"2L\",\n \"city\": \"ALAMOGORDO\",\n \"state\": \"NM\",\n \"postalCode\": \"88310\",\n \"county\": \"OTERO\",\n \"country\": \"UNITED STATES\"\n },\n \"shipToAddress\": {\n \"businessName\": \"ODYSSEY INC\",\n \"lastName\": \"HOMER\",\n \"firstName\": \"SIMPSON\",\n \"address1\": \"1222 NE SW North Blvd\",\n \"address2\": \"2L\", \n \"city\": \"ALAMOGORDO\",\n \"state\": \"NM\",\n \"postalCode\": \"88310\",\n \"county\": \"OTERO\",\n \"country\": \"UNITED STATES\"\n },\n \"customerType\": \"COMMERCIAL\",\n \"entryType\": \"Customer\",\n \"phone1\": \"2054445555\",\n \"phone2\": \"\",\n \"email\": \"ODYSSEY@SIMPSON.COM\",\n \"preferredSalesperson1\": \"CARLS BAD\",\n \"preferredSalesperson2\": \"\",\n \"storeNumber\": 32,\n \"referralType\": \"Standalone\",\n \"referralMemberId\": 0,\n \"referralMemberName\": \"\"\n },\n {\n \"phone3\": \"\",\n \"contact1\": \"\",\n \"contact2\": \"\",\n \"active\": true,\n \"dateCreated\": \"2021-04-13T10:21:27\",\n \"createdBy\": \"CBanuelos\",\n \"dateUpdated\": \"2021-04-13T11:07:04\",\n \"updatedBy\": \"CBanuelos\",\n \"customerId\": 75696,\n \"customerAddress\": {\n \"businessName\": \"ABC CONTRACTORS\",\n \"lastName\": \"LETTERMAN\",\n \"firstName\": \"DILON\",\n \"address1\": \"123 FOUR DR\",\n \"address2\": \"FLOOR 1\",\n \"city\": \"ALABASTER\",\n \"state\": \"AL\",\n \"postalCode\": \"35007\",\n \"county\": \"JEFFERSON\",\n \"country\": null\n },\n \"shipToAddress\": {\n \"businessName\": \"ABC CONTRACTORS\",\n \"lastName\": \"LETTERMAN\",\n \"firstName\": \"DILON\",\n \"address1\": \"123 FOUR DR\",\n \"address2\": \"FLOOR 1\",\n \"city\": \"ALABASTER\",\n \"state\": \"AL\",\n \"postalCode\": \"35007\",\n \"county\": \"JEFFERSON\",\n \"country\": null\n },\n \"customerType\": \"COMMERCIAL\",\n \"entryType\": \"Customer\",\n \"phone1\": \"2052042031\",\n \"phone2\": \"9371567\",\n \"email\": \"CB@TESTING.COM\",\n \"preferredSalesperson1\": \"CARLS GOOD\",\n \"preferredSalesperson2\": \"\",\n \"storeNumber\": 32,\n \"referralType\": \"Standalone\",\n \"referralMemberId\": 0,\n \"referralMemberName\": \"\"\n }\n ],\n \"detail\": null\n}"}],"_postman_id":"f8265656-edf3-4e69-9a5f-b06c568e87aa"},{"name":"Get Customer","event":[{"listen":"test","script":{"id":"cd01ca63-dfbd-4b8a-babd-6194c14feb85","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"customer\");","});"],"type":"text/javascript"}}],"id":"60d6d32e-713d-4f3b-8041-017fae5f0f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.rfms.online/v2/customer/{{customerId}}","description":"

Fetch information about one specific customer by ID

\n
For those with RFMS Version 20.99 or higher, customer internal notes will also be viewable within the returned customer record
\n

\\n

Customer Internal Note for CB Apartments

\\n

\"\n },\n \"detail\": {\n \"customerSource\": \"Customer\",\n \"customerSourceId\": 75526,\n \"salesLeadId\": 0,\n \"customerName\": \"APARTMENTS\",\n \"customerFirstName\": \"CB\",\n \"actualCustomerFirstName\": \"CB\",\n \"customerLastName\": \"APARTMENTS\",\n \"customerBusinessName\": \"CARLOS BANUELOS\",\n \"customerAddress\": \"123 TEST AVE\",\n \"customerAddress2\": \"\",\n \"customerCity\": \"SAN DIEGO\",\n \"customerState\": \"CA\",\n \"customerZIP\": \"92026\",\n \"customerPhone\": \"2051234567\",\n \"customerPhone2\": \"\",\n \"customerPhone3\": \"\",\n \"customerEmail\": \"TEST@TEST.COM\",\n \"customerCounty\": null,\n \"shipToName\": \"BANUELOS\",\n \"shipToFirstName\": \"CARLOS\",\n \"shipToLastName\": \"BANUELOS\",\n \"shipToBusinessName\": \"\",\n \"actualShipToFirstName\": \"CARLOS\",\n \"shipToAddress\": \"123 TEST AVE\",\n \"shipToAddress2\": \"\",\n \"shipToCity\": \"SAN DIEGO\",\n \"shipToState\": \"CA\",\n \"shipToZIP\": \"92026\",\n \"shipToCounty\": null,\n \"customerType\": \"CASH & CARRY\",\n \"referralType\": \"Standalone\",\n \"referralMemberId\": 0,\n \"referralMemberName\": \"\",\n \"taxStatus\": \"Tax\",\n \"taxMethod\": \"SalesTax\",\n \"preferredPriceLevel\": 0,\n \"preferredSalesperson1\": \"CARLOS BANUELOS\",\n \"preferredSalesperson2\": \"\",\n \"jobNumberOverride\": null,\n \"entryType\": \"Customer\",\n \"terms\": \"\",\n \"termDays\": 0,\n \"creditLimit\": 0,\n \"defaultStore\": 32,\n \"internalNotes\": \"

\\n

Customer Internal Note for CB Apartments

\\n

\",\n \"remarks\": []\n }\n}"}],"_postman_id":"60d6d32e-713d-4f3b-8041-017fae5f0f89"},{"name":"Get Customer Values","id":"0ea37758-9df1-466c-8183-018f29732265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rfms.online/v2/customers","description":"

When creating customers, some fields only allow certain values. This method returns those fields and a list of the allowed values for each. Note that since this method does not actually communicate with the store, it returns a simple result - not the regular response with status and result.

Create a new customer or update an existing one. When creating a new customer the customerId element should be omitted.

Some of the values must match a valid selection. For example, customerType must match one of several specific values. To see the available values, GET /customers (see above.)

For users who have the correct parameters enabled, an association to a member (Main) or client (Branch) type referral may be made by including the following field(s):

{\n    \"referralType\": \"client\", //or \"member\"\n    \"referralMemberId\" 1234 //required if referralType is \"client\", otherwise exclude from request body\n}\n\n

For users that are associated with CCA/DRIVE, the lmsId field may be specified among the other elements like so:

{\n    \"customerType\": \"COMMERCIAL\",\n    \"lmsId\": \"ABA123\",\n    \"customerAddress\": {...}\n}\n

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","customer",""],"host":["api","rfms","online"],"query":[],"variable":[]}},"response":[{"id":"3f3c37d3-159a-48e0-8c3f-2b5d1fd9d9ce","name":"Create a New Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerType\": \"COMMERCIAL\",\r\n \"entryType\": \"Customer\", \r\n \"customerAddress\": {\r\n \"lastName\": \"DOE\",\r\n \"firstName\": \"JOHN\",\r\n \"address1\": \"1234 MAIN ST\",\r\n \"address2\": \"STE 33\",\r\n \"city\": \"ANYTOWN\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"91332\",\r\n \"county\": \"LOS ANGELES\"\r\n },\r\n \"shipToAddress\": {\r\n \"lastName\": \"DOE\",\r\n \"firstName\": \"JOHN\",\r\n \"address1\": \"1234 MAIN ST\",\r\n \"address2\": \"STE 33\",\r\n \"city\": \"ANYTOWN\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"91332\",\r\n \"county\": \"LOS ANGELES\"\r\n },\r\n \"phone1\": \"661-555-1212\",\r\n \"phone2\": \"818-298-0000\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"taxStatus\": \"Tax\", \r\n \"taxMethod\": \"SalesTax\", \r\n \"preferredSalesperson1\": \"BOB\",\r\n \"preferredSalesperson2\": \"\"\r\n}"},"url":"https://api.rfms.online/v2/customer"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a695cb9c-69a5-4c65-9987-6b60631e684a","name":"Update a Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": 32394,\r\n \"customerType\": \"COMMERCIAL\",\r\n \"entryType\": \"Customer\", \r\n \"customerAddress\": {\r\n \"lastName\": \"DOE\",\r\n \"firstName\": \"JOHN\",\r\n \"address1\": \"1234 MAIN ST\",\r\n \"address2\": \"STE 33\",\r\n \"city\": \"ANYTOWN\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"91332\",\r\n \"county\": \"LOS ANGELES\"\r\n },\r\n \"shipToAddress\": {\r\n \"lastName\": \"DOE\",\r\n \"firstName\": \"JOHN\",\r\n \"address1\": \"1234 MAIN ST\",\r\n \"address2\": \"STE 33\",\r\n \"city\": \"ANYTOWN\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"91332\",\r\n \"county\": \"LOS ANGELES\"\r\n },\r\n \"phone1\": \"661-555-1212\",\r\n \"phone2\": \"818-298-0000\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"taxStatus\": \"Tax\", \r\n \"taxMethod\": \"SalesTax\", \r\n \"preferredSalesperson1\": \"BOB\",\r\n \"preferredSalesperson2\": \"\"\r\n}"},"url":"https://api.rfms.online/v2/customer/"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"785a03fc-1c01-4f3c-9472-983e60d27baa"},{"name":"Create an Opportunity","id":"eec411fd-a346-4e4f-94cd-f3c3bdb27a68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"createOrder\": false,\r\n \"notes\": \"SAMPLE NOTES\",\r\n \"estimatedDeliveryDate\": \"3/1/2019\",\r\n \"storeNumber\": 32,\r\n \"customerType\": \"COMMERCIAL\",\r\n \"entryType\": \"Customer\", \r\n \"customerAddress\": {\r\n \t\"businessName\": \"ACME\",\r\n \"lastName\": \"DOE\",\r\n \"firstName\": \"JOHN\",\r\n \"address1\": \"1234 MAIN ST\",\r\n \"address2\": \"STE 33\",\r\n \"city\": \"ANYTOWN\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"91332\",\r\n \"county\": \"LOS ANGELES\"\r\n },\r\n \"shipToAddress\": {\r\n \"lastName\": \"DOE\",\r\n \"firstName\": \"JOHN\",\r\n \"address1\": \"1234 MAIN ST\",\r\n \"address2\": \"STE 33\",\r\n \"city\": \"ANYTOWN\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"91332\",\r\n \"county\": \"LOS ANGELES\"\r\n },\r\n \"phone1\": \"661-555-1212\",\r\n \"phone2\": \"818-298-0000\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"taxStatus\": \"Tax\", \r\n \"taxMethod\": \"SalesTax\", \r\n \"preferredSalesperson1\": \"BOB\",\r\n \"preferredSalesperson2\": \"\",\r\n \"poNumber\": \"12346\",\r\n \"jobNumber\": \"X22333\"\r\n}"},"url":"https://api.rfms.online/v2/opportunity","description":"

Create a new customer and a corresponding document. The document may be one of the following:

For companies with an active CRM license, a CRM Opportunity can be created by setting useCRM to true.
\n
An empty Quote if createOrder is false or omitted
\n
An empty Order if createOrder is true (see below for the option to create a web order or regular order)
\n
A BidPro estimate if useBidPro is true.
\n

The request is nearly identical to that of Create Customer, but includes a few additional elements that are specific to the document (quote or order) that will be created. Returns the new document number.

If your store is configured in such a way to allow referrals, an opportunity, like a customer, may also be assigned as either a member (Main) or client (Branch) type referral. See Create Or Update a Customer for more detailed instructions.

If your store is associated with CCA/DRIVE, lmsId may be added to a new opportunity as well. See Create Or Update Customer for more detailed instructions.

Using an existing customer

Depending on your store's configuration, an error might occur if a customer already exists with the same name and phone number. When that occurs, the response will look like this.

{\n    \"accepted\": false,\n    \"requestId\": \"\",\n    \"messages\": [\n        \"A Sales Lead, Prospect or Customer record with this name and phone number already exists.\",\n        \"existingCustomerId:74028\"\n    ]\n}\n\n

You can use this same method to create just the empty quote associated with the existing customer. To do that, include just the customerId and quote-specific fields, like this:

{\n  \"customerid\": 74028,\n  \"notes\": \"SAMPLE NOTES\",\n  \"estimatedDeliveryDate\": \"3/1/2019\",\n  \"storeNumber\": 32,\n  \"preferredSalesperson1\": \"BOB\",\n  \"preferredSalesperson2\": \"\"\n}\n\n

When using an existing customer, you can still optionally override the ship-to address by including the ship-to element, like this:

{\n  \"customerid\": 74028,\n  \"shipTo\": { ... },\n  ...\n}\n\n

Using BidPro

Rather than creating a corresponding quote, you can also create a blank BidPro estimate. To do this, include the following elements in your message:

{\n  \"useBidPro\": true,\n  \"modelName\": \"OPPORTUNITY\",\n  ...\n}\n\n

Model name is a required field for many stores when creating a BidPro estimate. You can pass any value you like for that and it will be included in the estimate.

Using Project Manager

To create a sales lead in Project Manager, include the following element in your message:

{\n  \"useProjectManager\": true,\n  ...\n}\n\n

Note that if this field is true, other flags, such as useBidPro or createOrder will be ignored.

Providing a custom document number

Normally, RFMS will generate a new quote, order, or estimate number. However, you can send the one you would like to use. Simply include this attribute:

{\n  \"documentNumber\": \"ABC123\",\n  ...\n}\n\n

Your store must be configured to allow this.

Business name behavior

The opportunity accepts a businessName for soldTo and shipTo, and if provided it will be recorded on the customer that is created. However, quotes and orders do not have this field.

If businessName is provided for an address, it will be used as the lastName on the quote or order, and the firstName will be left blank.

Specifying an Order Type

If the creation of an opportunity is to be associated with a new order, the way to specify a non web order is as follows. Otherwise, the order will be considered a web order

{\n  \"createOrder\": true,\n  \"orderType\": \"Order\"\n}\n\n

Saving to a secondary company

The default behavior of this method will be to save a new opportunity to the primary store associated with the public api. To override this behavior, add to the main body of the opportunity and populate the companyId field with the corresponding company id of the secondary company to which the opportunity must be added.

Additional Parameters

The following table describes some additional parameters that can be saved to the opportunity:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
journey	string	Code indicating the \"customer journey\" this opportunity should enter. (Third-party developer feature only)
journeyDetail	string	Journey-specific details about the journey. (Third-party developer feature only)
marketingOptIn	object	See available fields below
marketingOptIn: email	boolean	Required. Indicates if the user has opted into receiving emails.
marketingOptIn: sms	boolean	Required. Indicates if the user has opted into receiving text messages.
marketingOptIn: optInDate	DateTime	Optional. The time stamp of the opt-in. (May be used for compliance purposes)
marketingOptIn: ipAddress	string	Optional. The IP address of the opt-in. (May be used for compliance purposes)

Fetches all opportunities that have been modified within the past seven days

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Gets all CRM opportunities by stage. \nStages to select from include the following:

To Do
Contact
Products
Measure
Quote
Won
Lost

Please note that within the CRM application, a company can rename stages. The above stages are the generic names, not the company-specific alias'. They are listed by the order in which they appear in CRM

Stage by which to filter

\n","type":"text/plain"},"type":"any","value":null,"key":"stage"}]}},"response":[{"id":"51856ad4-79ce-4328-9fd4-5eb059302944","name":"Get CRM Opportunities By Stage","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rfms.online/v2/opportunities/:stage","protocol":"https","host":["api","rfms","online"],"path":["v2","opportunities",":stage"],"variable":[{"key":"stage","value":"Measure"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcTEdpdWxpYW5vXHJlcG9zXG1lYXN1cmVjbG91ZGFwaVxSZm1zUHVibGljQXBpXHYyXG9wcG9ydHVuaXRpZXNcTWVhc3VyZQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 18 Nov 2021 14:59:58 GMT"},{"key":"Content-Length","value":"14744"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": [\n {\n \"id\": \"DP3LP1E3C7\",\n \"title\": \"KONG, KING\",\n \"customerId\": \"75065\",\n \"salesperson\": \"giul@branch.com\",\n \"store\": 0,\n \"dateCreated\": \"11/27/2019\",\n \"lastModified\": \"6/7/2021 11:42 AM\",\n \"totalValue\": 254.62,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"2GLKH6725E\",\n \"title\": \"JAMES SMITH\",\n \"customerId\": \"1392\",\n \"salesperson\": \"SNEAKY PETE\",\n \"store\": 0,\n \"dateCreated\": \"2/27/2020\",\n \"lastModified\": \"11/16/2020 9:56 AM\",\n \"totalValue\": 3588.19,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 986136,\n \"colorId\": 7813587,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 8.39\n }\n ]\n },\n {\n \"id\": \"VB4HGK5BZ3\",\n \"title\": \"BEERHAUS, ARCHIE\",\n \"customerId\": \"75434\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 0,\n \"dateCreated\": \"5/27/2020\",\n \"lastModified\": \"9/3/2020 8:10 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"AY4N0JJQQ6\",\n \"title\": \"1569610676320, JOETRUSTWORTHY 2020-05-28\",\n \"customerId\": \"74500\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"5/28/2020\",\n \"lastModified\": \"7/29/2020 9:44 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"MD26PWPVUL\",\n \"title\": \"BUILDER, BOB\",\n \"customerId\": \"75483\",\n \"salesperson\": \"justin@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"7/10/2020\",\n \"lastModified\": \"8/26/2020 10:42 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 963816,\n \"colorId\": 7602150,\n \"quantity\": 20,\n \"sampleCheckedOut\": false,\n \"price\": 1.68\n }\n ]\n },\n {\n \"id\": \"84IL5GNF8T\",\n \"title\": \"MM-3044, TIFFANY\",\n \"customerId\": \"75509\",\n \"salesperson\": \"test1@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"8/28/2020\",\n \"lastModified\": \"9/2/2020 11:28 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1002684,\n \"colorId\": 7973480,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 5.03\n }\n ]\n },\n {\n \"id\": \"TAAPR8N5VA\",\n \"title\": \"MM-3044, LAURA\",\n \"customerId\": \"75510\",\n \"salesperson\": \"test1@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"8/28/2020\",\n \"lastModified\": \"8/27/2020 10:17 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1002684,\n \"colorId\": 7973463,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 5.03\n }\n ]\n },\n {\n \"id\": \"UYYHUFO7CQ\",\n \"title\": \"FRIEDMAN, JONATHAN\",\n \"customerId\": \"3129\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"9/3/2020\",\n \"lastModified\": \"5/26/2021 3:55 PM\",\n \"totalValue\": 10000,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1034528,\n \"colorId\": 8354181,\n \"quantity\": 1200,\n \"sampleCheckedOut\": false,\n \"price\": 4.32\n }\n ]\n },\n {\n \"id\": \"VXZNBN367O\",\n \"title\": \"BANUELOS, CARLOS\",\n \"customerId\": \"75515\",\n \"salesperson\": \"eta@branch.com\",\n \"store\": 0,\n \"dateCreated\": \"9/9/2020\",\n \"lastModified\": \"10/1/2020 12:29 PM\",\n \"totalValue\": 2723.94,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"GVYA07WGZH\",\n \"title\": \"BEVERLY SMITH\",\n \"customerId\": \"1286\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"10/6/2020\",\n \"lastModified\": \"10/6/2020 11:10 AM\",\n \"totalValue\": 3687,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"PEV0NZMMAG\",\n \"title\": \"BRANDON SMITH\",\n \"customerId\": \"968\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"10/6/2020\",\n \"lastModified\": \"10/6/2020 11:16 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"60TSWOVWE0\",\n \"title\": \"EVAN SMITH\",\n \"customerId\": \"2068\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"10/6/2020\",\n \"lastModified\": \"10/25/2020 11:47 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"K0ZSRDY7AO\",\n \"title\": \"BEVERLY SMITH\",\n \"customerId\": \"1286\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"10/7/2020\",\n \"lastModified\": \"10/20/2020 11:40 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"OGVIKY86T2\",\n \"title\": \"1, MMTEST\",\n \"customerId\": \"75552\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 0,\n \"dateCreated\": \"10/8/2020\",\n \"lastModified\": \"10/8/2020 9:42 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"V47LRF2ZZL\",\n \"title\": \"UNREF, UNREF\",\n \"customerId\": \"75571\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"10/22/2020\",\n \"lastModified\": \"3/1/2021 3:12 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 963816,\n \"colorId\": 7602159,\n \"quantity\": 216,\n \"sampleCheckedOut\": false,\n \"price\": 3.99\n },\n {\n \"id\": 1037747,\n \"colorId\": 8371147,\n \"quantity\": 100,\n \"sampleCheckedOut\": false,\n \"price\": 0.71\n }\n ]\n },\n {\n \"id\": \"O3L7KV8Y8Z\",\n \"title\": \"BALAKITSIS, THOMAS\",\n \"customerId\": \"2762\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"1/11/2021\",\n \"lastModified\": \"1/11/2021 3:45 PM\",\n \"totalValue\": 744.75,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"WFJ8Q004NI\",\n \"title\": \"BRANDON SMITH\",\n \"customerId\": \"968\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"1/15/2021\",\n \"lastModified\": \"1/14/2021 7:46 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"HO4MBSYAI2\",\n \"title\": \"WILSON, KURT & SARAH\",\n \"customerId\": \"75632\",\n \"salesperson\": \"kurt@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"1/15/2021\",\n \"lastModified\": \"7/7/2021 11:02 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"M11UIYCQEN\",\n \"title\": \"BROWN, JAMES\",\n \"customerId\": \"75633\",\n \"salesperson\": \"kurt@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"1/15/2021\",\n \"lastModified\": \"1/19/2021 1:16 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1038121,\n \"colorId\": 8371554,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n },\n {\n \"id\": 1038133,\n \"colorId\": 8371627,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n },\n {\n \"id\": 1038337,\n \"colorId\": 8374248,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n },\n {\n \"id\": 1038131,\n \"colorId\": 8371603,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n }\n ]\n },\n {\n \"id\": \"IDZ14UPJMM\",\n \"title\": \"HURBERD THOMAS\",\n \"customerId\": \"667\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"1/19/2021\",\n \"lastModified\": \"1/19/2021 3:48 PM\",\n \"totalValue\": 1602.86,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"0QJN8XLA4H\",\n \"title\": \"CONWELL, THOMAS\",\n \"customerId\": \"2763\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"1/19/2021\",\n \"lastModified\": \"1/19/2021 5:37 PM\",\n \"totalValue\": 1240.52,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"IS7X7IAB4I\",\n \"title\": \"BEVERLY SMITH\",\n \"customerId\": \"1286\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"1/19/2021\",\n \"lastModified\": \"1/19/2021 5:44 PM\",\n \"totalValue\": 1240.52,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"PHTHYZ70O8\",\n \"title\": \"CONWELL, THOMAS\",\n \"customerId\": \"2763\",\n \"salesperson\": \"th@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"1/25/2021\",\n \"lastModified\": \"1/25/2021 11:46 AM\",\n \"totalValue\": 689.13,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"D7NCGLH77H\",\n \"title\": \"CONWELL, THOMAS\",\n \"customerId\": \"2763\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"1/27/2021\",\n \"lastModified\": \"4/27/2021 3:11 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"XGXYQBJZZW\",\n \"title\": \"VELAND, RUDY\",\n \"customerId\": \"72239\",\n \"salesperson\": \"newipad@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"2/5/2021\",\n \"lastModified\": \"7/15/2021 9:43 AM\",\n \"totalValue\": 5915.28,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1002684,\n \"colorId\": 7973519,\n \"quantity\": 1176,\n \"sampleCheckedOut\": false,\n \"price\": 5.03\n }\n ]\n },\n {\n \"id\": \"E7S3HV5WYJ\",\n \"title\": \"CRM-377 multi option\",\n \"customerId\": \"72239\",\n \"salesperson\": \"newipad@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"2/5/2021\",\n \"lastModified\": \"7/5/2021 1:12 PM\",\n \"totalValue\": 18392.64,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 992048,\n \"colorId\": 7814432,\n \"quantity\": 1176,\n \"sampleCheckedOut\": false,\n \"price\": 3.35\n },\n {\n \"id\": 1002684,\n \"colorId\": 7973480,\n \"quantity\": 1176,\n \"sampleCheckedOut\": false,\n \"price\": 12.29\n },\n {\n \"id\": 1002684,\n \"colorId\": 7973519,\n \"quantity\": 1176,\n \"sampleCheckedOut\": true,\n \"price\": 6.72\n },\n {\n \"id\": 992048,\n \"colorId\": 7814424,\n \"quantity\": 1176,\n \"sampleCheckedOut\": true,\n \"price\": 1.42\n },\n {\n \"id\": 992048,\n \"colorId\": 7814429,\n \"quantity\": 1176,\n \"sampleCheckedOut\": false,\n \"price\": 1.17\n },\n {\n \"id\": 1002684,\n \"colorId\": 7973463,\n \"quantity\": 1176,\n \"sampleCheckedOut\": false,\n \"price\": 5.65\n }\n ]\n },\n {\n \"id\": \"DSJ2PT4QF9\",\n \"title\": \"DANNY WILSON\",\n \"customerId\": \"1472\",\n \"salesperson\": \"kurt@rfmstest.com\",\n \"store\": 50,\n \"dateCreated\": \"3/5/2021\",\n \"lastModified\": \"7/15/2021 9:43 AM\",\n \"totalValue\": 3531.84,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 988174,\n \"colorId\": 7783472,\n \"quantity\": 800,\n \"sampleCheckedOut\": false,\n \"price\": 3.12\n },\n {\n \"id\": 963552,\n \"colorId\": 7595238,\n \"quantity\": 89,\n \"sampleCheckedOut\": false,\n \"price\": 3.04\n },\n {\n \"id\": 988174,\n \"colorId\": 7783458,\n \"quantity\": 900,\n \"sampleCheckedOut\": false,\n \"price\": 3.12\n },\n {\n \"id\": 918196,\n \"colorId\": 6983586,\n \"quantity\": 696,\n \"sampleCheckedOut\": false,\n \"price\": 1.04\n }\n ]\n },\n {\n \"id\": \"61Y53UEEBT\",\n \"title\": \"MARTINEZ, STEVE\",\n \"customerId\": \"75653\",\n \"salesperson\": \"carlos2@branch.com\",\n \"store\": 50,\n \"dateCreated\": \"3/5/2021\",\n \"lastModified\": \"10/27/2021 9:49 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1038521,\n \"colorId\": 8377046,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n },\n {\n \"id\": 1038520,\n \"colorId\": 8377045,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n }\n ]\n },\n {\n \"id\": \"EASWFSG0VC\",\n \"title\": \"JACKSON, LAMAR\",\n \"customerId\": \"75686\",\n \"salesperson\": \"carlos2@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"3/22/2021\",\n \"lastModified\": \"9/29/2021 2:32 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1038520,\n \"colorId\": 8377045,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n },\n {\n \"id\": 1038521,\n \"colorId\": 8377046,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n }\n ]\n },\n {\n \"id\": \"8BD68QW51V\",\n \"title\": \"TESTINGLN, TESTINGFN\",\n \"customerId\": \"75689\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"4/2/2021\",\n \"lastModified\": \"6/30/2021 6:13 PM\",\n \"totalValue\": 178,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1019787,\n \"colorId\": 8199835,\n \"quantity\": 89,\n \"sampleCheckedOut\": false,\n \"price\": 2\n }\n ]\n },\n {\n \"id\": \"LYXS2CQ1R8\",\n \"title\": \"BANUELOS2, CARLOS\",\n \"customerId\": \"75561\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 0,\n \"dateCreated\": \"5/5/2021\",\n \"lastModified\": \"5/5/2021 11:02 AM\",\n \"totalValue\": 1089.83,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"N6Q1627CRG\",\n \"title\": \"DONALD SMITHs\",\n \"customerId\": \"804\",\n \"salesperson\": \"test1@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"5/10/2021\",\n \"lastModified\": \"6/7/2021 12:08 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1020164,\n \"colorId\": 0,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n }\n ]\n },\n {\n \"id\": \"EBF1VS1CMY\",\n \"title\": \"CRM-510, WALLY\",\n \"customerId\": \"75744\",\n \"salesperson\": \"newipad@rfmstest.com\",\n \"store\": 32,\n \"dateCreated\": \"7/27/2021\",\n \"lastModified\": \"8/26/2021 3:56 PM\",\n \"totalValue\": 1157.1,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1002684,\n \"colorId\": 7973463,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 5.03\n }\n ]\n },\n {\n \"id\": \"KPA1B2GLFI\",\n \"title\": \"Carlos, Carlos\",\n \"customerId\": \"75767\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 0,\n \"dateCreated\": \"9/10/2021\",\n \"lastModified\": \"9/29/2021 2:21 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 1038520,\n \"colorId\": 8377045,\n \"quantity\": 0,\n \"sampleCheckedOut\": false,\n \"price\": 0\n }\n ]\n },\n {\n \"id\": \"GGY9M4WPZ7\",\n \"title\": \"!, ROOM\",\n \"customerId\": \"75860\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 53,\n \"dateCreated\": \"9/24/2021\",\n \"lastModified\": \"9/24/2021 2:34 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"RNEVLAM1GK\",\n \"title\": \"PM, NEW\",\n \"customerId\": \"75861\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 53,\n \"dateCreated\": \"9/24/2021\",\n \"lastModified\": \"9/24/2021 2:39 PM\",\n \"totalValue\": 1203.11,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"CEQ4OWSLZG\",\n \"title\": \"BANCASH, CARCASH\",\n \"customerId\": \"75863\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"10/4/2021\",\n \"lastModified\": \"11/16/2021 3:55 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"4YYGYMCYOS\",\n \"title\": \"MOE-1044, RUDY\",\n \"customerId\": \"75641\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"10/11/2021\",\n \"lastModified\": \"10/27/2021 10:52 AM\",\n \"totalValue\": 49.92,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": [\n {\n \"id\": 992048,\n \"colorId\": 7814434,\n \"quantity\": 48,\n \"sampleCheckedOut\": false,\n \"price\": 1.04\n }\n ]\n },\n {\n \"id\": \"1DEPWDKS3J\",\n \"title\": \"BBUILDER, CBUILDER\",\n \"customerId\": \"75865\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"10/12/2021\",\n \"lastModified\": \"10/22/2021 3:11 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"T8GBXQOWM7\",\n \"title\": \"CORBIN CUSTOM HOMEBUILDERS\",\n \"customerId\": \"354\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"10/12/2021\",\n \"lastModified\": \"11/15/2021 1:33 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"382Q58TCE4\",\n \"title\": \"BANUELOS, CHRIS\",\n \"customerId\": \"75702\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 32,\n \"dateCreated\": \"11/1/2021\",\n \"lastModified\": \"11/1/2021 10:21 AM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"MOYBSM1F5U\",\n \"title\": \"BANUELOS, CARLOS\",\n \"customerId\": \"75515\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 65,\n \"dateCreated\": \"11/3/2021\",\n \"lastModified\": \"11/3/2021 2:51 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"KI1GLT7R8K\",\n \"title\": \"BANUELOS, CARLOS\",\n \"customerId\": \"75741\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 65,\n \"dateCreated\": \"11/3/2021\",\n \"lastModified\": \"11/15/2021 1:31 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"MQDVW3KE0Y\",\n \"title\": \"BANUELOS, CARLOS\",\n \"customerId\": \"75608\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 65,\n \"dateCreated\": \"11/3/2021\",\n \"lastModified\": \"11/3/2021 3:16 PM\",\n \"totalValue\": 0,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n },\n {\n \"id\": \"LEDQPKZQZF\",\n \"title\": \"BANUELOS, CARLOS\",\n \"customerId\": \"75608\",\n \"salesperson\": \"carlos@branch.com\",\n \"store\": 65,\n \"dateCreated\": \"11/3/2021\",\n \"lastModified\": \"11/12/2021 1:24 PM\",\n \"totalValue\": 1032.88,\n \"stage\": \"Measure\",\n \"quotes\": [],\n \"quoteApproval\": null,\n \"orders\": [],\n \"products\": []\n }\n ],\n \"detail\": null\n}"}],"_postman_id":"cb235a8c-8d7e-415a-bb87-1a0e0e899704"},{"name":"Get Opportunity Change Logs","id":"8360dae6-5d49-4f7e-a18f-679b767f3291","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rfms.online/v2/opportunities/lastmodified","description":"

Retrieves a list of opportunities that have been modified or created in the last seven days. If an opportunity's status has changed, the change will be recorded and the opportunity will be included in the list returned by this method.

\n
This method requires the \"Plus\" level of the API product.
\n

Fetches an opportunity by ID

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Access Customer information

\n
The methods in this section require the \"Standard\" level of the API product as a minimum. Requests from \"Plus\" and \"Enterprise\" level API accounts are also acceptable.
\n

\n","event":[{"listen":"prerequest","script":{"id":"fd31c5ef-2284-405f-8424-75d2d325fdbc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fbd85097-0ff0-48a8-997f-25ecca492e3a","type":"text/javascript","exec":[""]}}],"_postman_id":"fffaef83-9f0f-4f56-a0f8-c0a2e7904c92","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}}},{"name":"Order Entry","item":[{"name":"Get order values","event":[{"listen":"test","script":{"id":"9421a9de-0642-4d4e-9236-d8ba0b666222","exec":["var jsonData = JSON.parse(responseBody);\r","\r","tests[\"Status code is 200\"] = responseCode.code === 200;\r","tests[\"Request is accepted\"] = jsonData.accepted;\r","postman.setEnvironmentVariable(\"lastMessage\", jsonData.requestId);\r","\r",""],"type":"text/javascript"}}],"id":"37a93689-1503-4605-8e5c-f490d615cac0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.rfms.online/v2/order","description":"

This will return master lists that can be used when creating new quotes or orders.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Retrieve a specific quote.

Lock the quote

\n","type":"text/plain"},"key":"locked","value":"false"},{"description":{"content":"

Returns attachments associated with the quote

\n","type":"text/plain"},"key":"includeAttachments","value":"true"}],"variable":[{"description":{"content":"

Quote number to get

\n","type":"text/plain"},"type":"string","value":"","key":"number"}]}},"response":[{"id":"f2480abd-7466-4c2b-b4e5-18fbcc183aae","name":"Get Quote","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.rfms.online/v2/quote/ES002971?locked=false&includeAttachments=true","protocol":"https","host":["api","rfms","online"],"path":["v2","quote","ES002971"],"query":[{"key":"locked","value":"false","type":"text"},{"key":"includeAttachments","value":"true","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"2161"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 21 Apr 2021 12:18:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"id\": \"35813\",\n \"number\": \"ES002971\",\n \"originalNumber\": \"ES002971\",\n \"category\": \"OriginalInvoice\",\n \"soldTo\": {\n \"customerId\": 75515,\n \"phone1\": \"000-000-0205\",\n \"phone2\": \"\",\n \"email\": \"TEST@TEST.COM\",\n \"customerType\": \"RETAIL-INSTALL\",\n \"businessName\": null,\n \"lastName\": \"BANUELOS\",\n \"firstName\": \"CARLOS\",\n \"address1\": \"123 TEST TUSCALOOSA AVE\",\n \"address2\": \"\",\n \"city\": \"TUSCALOOSA\",\n \"state\": \"AL\",\n \"postalCode\": \"35405\",\n \"county\": \"TUSCALOOSA\"\n },\n \"shipTo\": {\n \"businessName\": null,\n \"lastName\": \"BANUELOS\",\n \"firstName\": \"CARLOS\",\n \"address1\": \"123 TEST TUSCALOOSA AVE\",\n \"address2\": \"\",\n \"city\": \"TUSCALOOSA\",\n \"state\": \"AL\",\n \"postalCode\": \"35405\",\n \"county\": \"TUSCALOOSA\"\n },\n \"salesperson1\": \"KURT WILSON\",\n \"salesperson2\": \"\",\n \"salespersonSplitPercent\": 1,\n \"storeCode\": \" \",\n \"storeNumber\": 32,\n \"jobNumber\": \"GRAIL\",\n \"poNumber\": \"\",\n \"privateNotes\": \"\",\n \"publicNotes\": \"\",\n \"workOrderNotes\": \"\",\n \"estimatedDeliveryDate\": \"2021-04-20\",\n \"enteredDate\": \"2020-10-01\",\n \"measureDate\": \"\",\n \"taxStatus\": \"Tax\",\n \"taxMethod\": \"SalesTax\",\n \"adSource\": null,\n \"userOrderTypeId\": 0,\n \"serviceTypeId\": 0,\n \"contractTypeId\": 0,\n \"totals\": {\n \"material\": 144000,\n \"labor\": 0,\n \"misc\": 0,\n \"total\": 156960,\n \"salesTax\": 12960,\n \"miscTax\": 0,\n \"grandTotal\": 156960,\n \"recycleFee\": 0\n },\n \"lines\": [\n {\n \"id\": 217399,\n \"lineNumber\": 1,\n \"productCode\": \"01\",\n \"rollItemNumber\": \"\",\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"colorName\": \"AMERICANA\",\n \"supplierName\": \"MOHAWK INDUSTRIES\",\n \"quantity\": 11999.9997,\n \"saleUnits\": \"SF\",\n \"freight\": 0,\n \"unitPrice\": 12,\n \"total\": 144000,\n \"isUseTaxLine\": false,\n \"notes\": \"\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": \"None\",\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": [],\n \"workOrderLines\": [\n {\n \"lineNumber\": 1,\n \"areaName\": \"TEST2 FOR API2\",\n \"quantity\": 11999.9997,\n \"rate\": 0,\n \"notes\": \"\"\n }\n ]\n }\n ],\n \"attachments\": [],\n \"storeSpecific\": null,\n \"isExportedToOrder\": false,\n \"quoteDate\": \"2020-10-01\",\n \"orderNumber\": \"CG100223\",\n \"orderDate\": \"2020-10-01\",\n \"deliveryDate\": \"\",\n \"dueDate\": \"\",\n \"closedDate\": \"\",\n \"billedDate\": \"\",\n \"completedDate\": \"\",\n \"billingGroup\": null,\n \"payment\": {\n \"paidDate\": \"\",\n \"paidAmount\": 0,\n \"balanceDue\": 156960\n }\n },\n \"detail\": {\n \"id\": \"35813\",\n \"documentNumber\": \"ES002971\",\n \"category\": \"OriginalInvoice\",\n \"originalDocumentNumber\": \"ES002971\",\n \"isWebOrder\": false,\n \"documentType\": 0,\n \"customer\": {\n \"customerSource\": \"Customer\",\n \"customerSourceId\": 75515,\n \"salesLeadId\": 0,\n \"customerName\": \"BANUELOS\",\n \"customerFirstName\": \"CARLOS\",\n \"actualCustomerFirstName\": null,\n \"customerLastName\": null,\n \"customerBusinessName\": null,\n \"customerAddress\": \"123 TEST TUSCALOOSA AVE\",\n \"customerAddress2\": \"\",\n \"customerCity\": \"TUSCALOOSA\",\n \"customerState\": \"AL\",\n \"customerZIP\": \"35405\",\n \"customerPhone\": \"000-000-0205\",\n \"customerPhone2\": \"\",\n \"customerPhone3\": null,\n \"customerEmail\": \"TEST@TEST.COM\",\n \"customerCounty\": \"TUSCALOOSA\",\n \"shipToName\": \"BANUELOS\",\n \"shipToFirstName\": \"CARLOS\",\n \"shipToLastName\": null,\n \"shipToBusinessName\": null,\n \"actualShipToFirstName\": null,\n \"shipToAddress\": \"123 TEST TUSCALOOSA AVE\",\n \"shipToAddress2\": \"\",\n \"shipToCity\": \"TUSCALOOSA\",\n \"shipToState\": \"AL\",\n \"shipToZIP\": \"35405\",\n \"shipToCounty\": \"TUSCALOOSA\",\n \"customerType\": \"RETAIL-INSTALL\",\n \"referralType\": null,\n \"referralMemberId\": 0,\n \"referralMemberName\": null,\n \"taxStatus\": \"Tax\",\n \"taxMethod\": \"SalesTax\",\n \"preferredPriceLevel\": 0,\n \"preferredSalesperson1\": null,\n \"preferredSalesperson2\": null,\n \"jobNumberOverride\": null,\n \"entryType\": null,\n \"terms\": null,\n \"termDays\": 0,\n \"creditLimit\": 0,\n \"defaultStore\": 0,\n \"internalNotes\": null,\n \"remarks\": null\n },\n \"salesperson\": \"KURT WILSON\",\n \"salesperson2\": \"\",\n \"salespersonCommissionSplitPercent\": 1,\n \"billingGroup\": null,\n \"measureDate\": null,\n \"estimatedDeliveryDate\": \"2021-04-20T00:00:00\",\n \"orderDate\": \"2020-10-01T00:00:00\",\n \"dueDate\": null,\n \"paidDate\": null,\n \"enteredDate\": \"2020-10-01T00:00:00\",\n \"deliveryDate\": null,\n \"closedDate\": null,\n \"billedDate\": null,\n \"completedDate\": null,\n \"poNumber\": \"\",\n \"storeNumber\": 32,\n \"storeDisplayCode\": \" \",\n \"isOccupied\": false,\n \"timeSlot\": 0,\n \"privateNotes\": \"\",\n \"publicNotes\": \"\",\n \"workOrderNotes\": \"\",\n \"adSource\": 0,\n \"jobNumber\": \"GRAIL\",\n \"modelName\": null,\n \"userOrderType\": 0,\n \"serviceType\": 0,\n \"contractType\": 0,\n \"totalTax\": 12960,\n \"state\": {\n \"documentId\": 35813,\n \"documentNumber\": \"ES002971\",\n \"documentType\": 0,\n \"originalDocumentNumber\": \"ES002971\",\n \"isExported\": false,\n \"isVoided\": false,\n \"salesTax\": 12960,\n \"grandTotal\": 156960,\n \"materialTotal\": 144000,\n \"laborTotal\": 0,\n \"miscCharges\": 0,\n \"invoiceTotal\": 156960,\n \"miscTax\": 0,\n \"recycleFee\": 0,\n \"totalPaid\": 0,\n \"balanceDue\": 156960\n },\n \"proSource\": {\n \"memberNumber\": 0,\n \"memberName\": \"\",\n \"businessName\": \"\"\n },\n \"lines\": [\n {\n \"lineId\": 217399,\n \"lineAction\": null,\n \"lineStatus\": \"None\",\n \"inTransit\": false,\n \"productCode\": \"01\",\n \"tabKey\": null,\n \"calcMethod\": null,\n \"saleUnits\": \"SF\",\n \"rollItemNumber\": \"\",\n \"styleSeqNumber\": 1020356,\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"styleNumber\": \"\",\n \"colorSeqNumber\": 8211669,\n \"colorName\": \"AMERICANA\",\n \"colorCode\": null,\n \"quantity\": 11999.9997,\n \"orderLength\": 1000,\n \"rollWidth\": 12,\n \"rollWidthInInches\": 0,\n \"lineNotes\": \"\",\n \"internalNotes\": \"\",\n \"unitPrice\": 12,\n \"lineNumber\": 1,\n \"lineTotal\": 144000,\n \"fixedTotal\": false,\n \"load\": 0,\n \"freight\": 0,\n \"salesTax\": 0,\n \"priceLevelNumber\": 0,\n \"inventorySeqNum\": 0,\n \"sampleTaken\": false,\n \"supplierName\": \"MOHAWK INDUSTRIES\",\n \"unitCost\": 0,\n \"useTaxLine\": false,\n \"componentsAreRoll\": false,\n \"subtype\": null,\n \"calcMatchType\": null,\n \"calcMatchTab\": null,\n \"lineGroupId\": 0,\n \"profitPercent\": 144000,\n \"areaName\": null,\n \"specialPOCostRef\": null,\n \"specialPOCost\": 0,\n \"specialPOCostComment\": \"\",\n \"promiseDate\": null,\n \"deliveryDate\": \"2021-04-20T00:00:00\",\n \"hide\": false,\n \"components\": [\n {\n \"lineNumber\": 1,\n \"name\": \"TEST2 FOR API2\",\n \"quantity\": 11999.9997,\n \"rate\": 0,\n \"lengthInInches\": 0,\n \"notes\": \"\"\n }\n ],\n \"attachedFiles\": []\n }\n ],\n \"attachedFiles\": [],\n \"lockInfo\": null,\n \"companyId\": null\n }\n}"}],"_postman_id":"fea344d6-b85c-4220-957f-5c2489b8320d"},{"name":"Create Quote","id":"5947b299-0df9-4198-a811-ffcf16050530","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"987654\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2019-07-01\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"userOrderTypeId\": 1,\n \"serviceTypeId\": 1,\n \"contractTypeId\": 1,\n \"timeSlot\": 2,\n \"isOccupied\": false,\n \"phase\": \"1\",\n \"model\": \"The Dystopian\",\n \"unit\": \"101\", \n \"lines\": [\n \t{\n \t\t\"productId\": 992048,\n \t\t\"colorId\": 7814430,\n \t\t\"quantity\": 12.00,\n \t\t\"priceLevel\": \"Price3\",\n \"lineGroupId\": 14\n \t}\n\t]\n}"},"url":"https://api.rfms.online/v2/quote/create","description":"

\n
This method requires the \"Enterprise\" level of the API product. Requests from other level API accounts will return Unauthorized.
\n

When creating referenced lines, only the productId, colorId, quantity, and price (either unitPrice or priceLevel) are needed. Optionally, unitCost can be set. The other attributes will be looked up from the product catalog and used automatically.

If a soldTo.customerId is provided, that customer will be fetched from the store and soldTo and shipTo information will be filled out using that customer. Any information provided in the API call for soldTo or shipTo will then be used to override the values from the store.

In order to relate an existing parent quote to the new quote, add the parameter, \"relatedQuote\" along with the parent quote number.

Example:

{\n    \"relatedQuote\": \"ES902830\"\n}\n\n

For Prosource users, to add a line using EcProductId and EcColorId values, simply include these values instead of using the default productId, colorId fields.

Example:

{\n    \"lines: [{ \n            \"ecProductId\": \"1234\", \n            \"ecColorId\": \"5678\",\n            \"quantity\": 32\n            }]\n}\n\n

Adding Work Order Lines

When adding work order lines to a specific line, keep in mind that the quantity needs to match (or in the case of multiple work order lines - add up to) the total quantity as defined in the order line. See Example - Create Quote with Work Order Lines for more details on the structure of the request.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","quote","create"],"host":["api","rfms","online"],"query":[],"variable":[]}},"response":[{"id":"bb684d10-c820-423c-91af-53d54f62cefc","name":"Create Quote using referenced line","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"token","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"987654\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2019-07-01\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"userOrderTypeId\": 1,\n \"serviceTypeId\": 1,\n \"contractTypeId\": 1, \n \"lines\": [\n \t{\n \t\t\"productId\": 992048,\n \t\t\"colorId\": 7814430,\n \t\t\"quantity\": 12.00,\n \t\t\"priceLevel\": \"Price3\"\n \t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/quote/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?XFxNYWNcSG9tZVxEb2N1bWVudHNcQ29kZVxSRk1TXE1lYXN1cmVDbG91ZEFwaVxSZm1zUHVibGljQXBpXHYyXHF1b3RlXGNyZWF0ZQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 16 Nov 2019 03:27:50 GMT"},{"key":"Content-Length","value":"54"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"ES903428\",\n \"detail\": null\n}"},{"id":"fca18583-24a1-42f7-a43e-2ce594c6a4fe","name":"Create Quote using unreferenced line","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"token","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"987654\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2019-07-01\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"lines\": [\n \t{\n\t\t\t\"productCode\": \"02\",\n\t \"styleName\": \"CLASSIC SHAG\",\n\t \"colorName\": \"MELLOW YELLOW\",\n\t \"supplierName\": \"WILLIAMS\",\n\t \"saleUnits\": \"SY\",\n\t \"unitPrice\": 8.99,\n\t \"quantity\": 90,\n\t \"notes\": \"hello\",\n\t \"lineStatus\": \"None\"\n\t\t} \t\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/quote/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?XFxNYWNcSG9tZVxEb2N1bWVudHNcQ29kZVxSRk1TXE1lYXN1cmVDbG91ZEFwaVxSZm1zUHVibGljQXBpXHYyXHF1b3RlXGNyZWF0ZQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 16 Nov 2019 03:27:50 GMT"},{"key":"Content-Length","value":"54"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"ES903428\",\n \"detail\": null\n}"},{"id":"6078756c-7015-4cda-a03d-89ecbe04883a","name":"Create Quote With Work Order Lines","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"token","type":"text","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"12345\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2021-11-01\",\n \"estimatedDeliveryDate\": \"2021-12-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"userOrderTypeId\": 1,\n \"serviceTypeId\": 1,\n \"contractTypeId\": 1, \n \"lines\": [\n \t{\n \t\t\"productId\": 992048,\n \t\t\"colorId\": 7814430,\n \t\t\"quantity\": 12.00,\n \t\t\"priceLevel\": \"Price3\",\n \"workOrderLines\": [\n {\n \"areaName\": \"ROOM 1\",\n \"quantity\": 12.00,\n \"notes\": \"New area\"\n }\n ]\n \t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/quote/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"182"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 01 Nov 2021 16:20:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"ES103603\",\n \"detail\": {\n \"docId\": \"37433\"\n }\n}"}],"_postman_id":"5947b299-0df9-4198-a811-ffcf16050530"},{"name":"Update Quote","id":"d9271213-3ef8-4f95-bc43-7a218f83314c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"number\": \"CG903368\",\n \"poNumber\": \"987654\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2019-07-01\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \"customerType\": \"DECORATOR\" },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"userOrderTypeId\": 2,\n \"serviceTypeId\": 1,\n \"contractTypeId\": 1,\n \"timeSlot\": 2,\n \"isOccupied\": false,\n \"phase\": \"2\",\n \"model\": \"The Dystopian\",\n \"unit\": \"101\" \n}"},"url":"https://api.rfms.online/v2/quote","description":"

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

All elements other than \"number\" are optional. Only include those elements you want to modify. All others, or those with a value of null, will be ignored and the existing value on the quote will remain unchanged.

Updating lines

\"Enterprise\" level API users can also add, delete, and edit lines. Here are some examples:

To delete a line, include just the line id and delete: true.

{\n    \"number\": \"ES903500\",\n    \"lines\": [ { \"id\": 215541, \"delete\": true } ]\n}\n\n

To edit a line, include the line id:

{\n    \"number\": \"ES903500\",\n    \"lines\": [ { \"id\": 215541, \"productId\": 866639, \"colorId\": 6414238, \"quantity\": 100, \"unitCost\": 2.1 } ]\n}\n\n

To add a new line, omit line id:

{\n    \"number\": \"ES903500\",\n    \"lines\": [ { \"productId\": 992048, \"colorId\": 567483, \"quantity\": 99 } ]\n}\n\n

When modifying or adding lines, the following elements are supported:

unitPrice
\n
quantity
\n
lineStatus
\n
productId
\n
colorId
\n
priceLevel
\n
unitCost
\n
lineGroupId
\n

When productId is supplied, information from the associated product is copied to the line. Price level can only be set when a productId is supplied. This rule also applies to unit cost, but only when editing or adding a referenced line or a line not associated with a service. Otherwise, the productId need not be provided.

Note on the isUseTaxLine element: isUseTaxLine element can be used only if store permissions allow for it, and if the quote (or order) has one of the following tax methods: LineTax, UseTax. Otherwise, any attempt to set that element will be ignored.

For Prosource users, to add a line using EcProductId and EcColorId values, simply include these values instead of using the default productId, colorId fields.

Example:

{\n    \"number\": \"ES123456\",\n    \"lines: [{ \n            \"ecProductId\": \"1234\", \n            \"ecColorId\": \"5678\",\n            \"quantity\": 32\n            }]\n}\n\n

Options for Updating Notes

To replace notes, include additional fields, as specified above.

To append notes, only include note fields in the body of the request.

\n
Note: Appending notes to a line requires Enterprise Level API access
\n

Example Note Append:

{\n    \"number\": \"ES903500\",\n    \"privateNotes\": \"this will be appended to existing notes, if any\",\n    \"publicNotes\": \"this will also be appened\",\n    \"lines\":[ \"id\": 215541, \"notes\": \"and this too will be appended to a line note\"}] \n}\n\n

Adding Work Order Lines

When adding or deleting work order lines to a specific line, keep in mind that the quantity needs to match (or in the case of multiple work order lines - add up to) the total quantity as defined in the order line. The structure for adding, editing and deleting work order lines is very similar to order lines. For example:

To delete a line, include the line id, work order line id, and delete: true.

{\n    \"number\": \"ES103603\",\n    \"lines\": [ { \"id\": 218796, \"workOrderLines\": [ { \"id\": 277302, \"delete\": true } ] } ]\n}\n\n

To edit a line, include the line id, work order line id:

{\n    \"number\": \"ES103603\",\n    \"lines\": [ { \"id\": 218796, \"workOrderLines\": [ {\"id\": 277302, \"areaName\": \"BR 2\" } ] } ]\n}\n\n

To add a work order line new line, omit line id:

{\n    \"number\": \"ES103603\",\n    \"lines\": [ { \"id\": 218796, \"workOrderLines\": [ {\"areaName\": \"Room 2\", \"notes\": \"new room\", \"quantity\": 99 } ] } ]\n}\n\n

Search for Quotes.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required	Meaning
searchText	true	Given text will be found in customer first or customer last name.
dateCreatedFrom	false	Search for a quote that was created after this date.
dateCreatedTo	false	Search for a quote that was created before this date
salesperson1	false	Filter quotes by a certain salesperson
salesperson2	false	Filter based on a secondary salesperson
customerId	false	Search based on customer Id
viewExportedOnly	false	Filter quotes based on export status. If true, only exported quotes will be returned
resultPageNumber	false	Specify a specific page of quote results to view. By default, returns first page of results

\n
Note: Each page contains ten results from the query, starting from most recently created.
\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","quote","find"],"host":["api","rfms","online"],"query":[],"variable":[]}},"response":[{"id":"233a98f3-f9de-4534-ac51-d27b05b31a6b","name":"Find Quotes","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"searchText\": \"Bill\",\r\n\t\"dateCreatedFrom\": \"1/1/2018\",\r\n\t\"dateCreatedTo\": \"4/1/2020\",\r\n\t\"salesperson1\": \"Kurt Wilson\",\r\n\t\"customerId\": 71805,\r\n\t\"viewExportedOnly\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/quote/find"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": [\n {\n \"documentNumber\": \"ES903247\",\n \"customerFirst\": \"JIM\",\n \"customerLast\": \"BUILDER\",\n \"customerType\": \"BUILDER\",\n \"createdDate\": \"2019-09-04T00:00:00\",\n \"grandTotal\": 12.6,\n \"status\": \"Exported\"\n },\n {\n \"documentNumber\": \"ES803033\",\n \"customerFirst\": \"JIM\",\n \"customerLast\": \"BUILDER\",\n \"customerType\": \"BUILDER\",\n \"createdDate\": \"2018-06-26T00:00:00\",\n \"grandTotal\": 6433.47,\n \"status\": \"Exported\"\n }\n ],\n \"detail\": [\n {\n \"documentNumber\": \"ES903247\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"JIM\",\n \"customerLast\": \"BUILDER\",\n \"customerType\": \"BUILDER\",\n \"createdDate\": \"2019-09-04T00:00:00\",\n \"grandTotal\": 12.6,\n \"status\": \"Exported\"\n },\n {\n \"documentNumber\": \"ES803033\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"JIM\",\n \"customerLast\": \"BUILDER\",\n \"customerType\": \"BUILDER\",\n \"createdDate\": \"2018-06-26T00:00:00\",\n \"grandTotal\": 6433.47,\n \"status\": \"Exported\"\n }\n ]\n}"},{"id":"402df6fa-6386-4acd-b0af-20593ecf3bfe","name":"Find Quotes - View Additional Pages","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"searchText\": \"Smith\",\r\n\t\"dateCreatedFrom\": \"1/1/2018\",\r\n\t\"salesperson1\": \"Kurt Wilson\",\r\n\t\"resultPageNumber\": 3\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/quote/find"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"796"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 15 Jul 2020 22:56:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": [\n {\n \"documentNumber\": \"ES903145\",\n \"customerFirst\": \"TOMMY\",\n \"customerLast\": \"BUILDER\",\n \"customerType\": \"BUILDER\",\n \"createdDate\": \"2019-06-11T00:00:00\",\n \"grandTotal\": 8863.64,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES903030\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-27T00:00:00\",\n \"grandTotal\": 4877.04,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902963\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-15T00:00:00\",\n \"grandTotal\": 0.0,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902953\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 1021.95,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902954\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 257.55,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902956\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 257.56,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902957\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 257.56,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902907\",\n \"customerFirst\": \"JOHNNY\",\n \"customerLast\": \"SMITH\",\n \"customerType\": \"CASH & CARRY\",\n \"createdDate\": \"2019-02-22T00:00:00\",\n \"grandTotal\": 0.0,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902852\",\n \"customerFirst\": \"\",\n \"customerLast\": \"SMITH & SMITH CONST.\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-01-23T00:00:00\",\n \"grandTotal\": 906.51,\n \"status\": \"Open\"\n },\n {\n \"documentNumber\": \"ES902839\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-01-16T00:00:00\",\n \"grandTotal\": 19305.39,\n \"status\": \"Open\"\n }\n ],\n \"detail\": [\n {\n \"documentNumber\": \"ES903145\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"TOMMY\",\n \"customerLast\": \"BUILDER\",\n \"customerType\": \"BUILDER\",\n \"createdDate\": \"2019-06-11T00:00:00\",\n \"grandTotal\": 8863.64,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES903030\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-27T00:00:00\",\n \"grandTotal\": 4877.04,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902963\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-15T00:00:00\",\n \"grandTotal\": 0.0,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902953\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 1021.95,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902954\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 257.55,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902956\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 257.56,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902957\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-03-08T00:00:00\",\n \"grandTotal\": 257.56,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902907\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"JOHNNY\",\n \"customerLast\": \"SMITH\",\n \"customerType\": \"CASH & CARRY\",\n \"createdDate\": \"2019-02-22T00:00:00\",\n \"grandTotal\": 0.0,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902852\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"\",\n \"customerLast\": \"SMITH & SMITH CONST.\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-01-23T00:00:00\",\n \"grandTotal\": 906.51,\n \"status\": \"Open\",\n \"isTemplate\": false\n },\n {\n \"documentNumber\": \"ES902839\",\n \"documentType\": 0,\n \"description\": \"\",\n \"customerFirst\": \"DANNY\",\n \"customerLast\": \"SMITH CONSTRUCTION\",\n \"customerType\": \"NEW RESIDENTIAL\",\n \"createdDate\": \"2019-01-16T00:00:00\",\n \"grandTotal\": 19305.39,\n \"status\": \"Open\",\n \"isTemplate\": false\n }\n ]\n}"}],"_postman_id":"33369bab-6e0b-444c-83f7-3b751c09c743"},{"name":"Get Quote Gross Profit","id":"e0a92f29-95e8-4933-bb2e-24c9ebad475a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rfms.online/v2/quote/grossprofit/ES803033","description":"

Get gross profit values, along with additional information, by providing a quote number.

\n
This method requires \"Plus\" level of API product at a minimum
\n

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Simply supply the quote number in the URL. If successful, the new order number is returned. The order will be flagged as a \"Web Order\".

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Retrieve a specific order.

Locking the Order

To request a lock when retrieving the order, add the query parameter locked=true

The lock returned on the order result can then be passed to the lockId field when saving the order. To manually unlock the order, see Unlock Document.

Lock the order

\n","type":"text/plain"},"key":"locked","value":"false"},{"description":{"content":"

Returns attachments associated with the order

\n","type":"text/plain"},"key":"includeAttachments","value":"true"}],"variable":[{"description":{"content":"

Order number to get

\n","type":"text/plain"},"type":"any","value":"","key":"number"}]}},"response":[{"id":"b2f45ac6-07e6-460e-a92b-b9283036d08c","name":"Get Order","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.rfms.online/v2/order/:number?locked=false&includeAttachments=true","protocol":"https","host":["api","rfms","online"],"path":["v2","order",":number"],"query":[{"key":"locked","value":"false","type":"text"},{"key":"includeAttachments","value":"true","type":"text"}],"variable":[{"key":"number","value":"","description":"Order number to get","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1302"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 21 Apr 2021 12:13:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"id\": \"83307\",\n \"number\": \"CG003659\",\n \"originalNumber\": \"\",\n \"category\": \"OriginalInvoice\",\n \"soldTo\": {\n \"customerId\": 75515,\n \"phone1\": \"205-555-5555\",\n \"phone2\": \"\",\n \"email\": \"TEST@TEST.COM\",\n \"customerType\": \"RETAIL-INSTALL\",\n \"businessName\": null,\n \"lastName\": \"BANUELOS\",\n \"firstName\": \"CARLOS\",\n \"address1\": \"555 TUSCALOOSA AVE\",\n \"address2\": \"\",\n \"city\": \"TUSCALOOSA\",\n \"state\": \"AL\",\n \"postalCode\": \"35405\",\n \"county\": \"TUSCALOOSA\"\n },\n \"shipTo\": {\n \"businessName\": null,\n \"lastName\": \"BANUELOS\",\n \"firstName\": \"CARLOS\",\n \"address1\": \"555 TUSCALOOSA AVE\",\n \"address2\": \"\",\n \"city\": \"TUSCALOOSA\",\n \"state\": \"AL\",\n \"postalCode\": \"35405\",\n \"county\": \"TUSCALOOSA\"\n },\n \"salesperson1\": \"CARLOS BANUELOS\",\n \"salesperson2\": \"\",\n \"salespersonSplitPercent\": 1,\n \"storeCode\": \" \",\n \"storeNumber\": 32,\n \"jobNumber\": \"\",\n \"poNumber\": \"\",\n \"privateNotes\": \"\",\n \"publicNotes\": \"\",\n \"workOrderNotes\": \"\",\n \"estimatedDeliveryDate\": \"2020-10-13\",\n \"enteredDate\": \"2020-09-16\",\n \"measureDate\": \"\",\n \"taxStatus\": \"Tax\",\n \"taxMethod\": \"SalesTax\",\n \"adSource\": null,\n \"userOrderTypeId\": 1,\n \"serviceTypeId\": 0,\n \"contractTypeId\": 1,\n \"totals\": {\n \"material\": 73740,\n \"labor\": 0,\n \"misc\": 0,\n \"total\": 80376.6,\n \"salesTax\": 6636.6,\n \"miscTax\": 0,\n \"grandTotal\": 80376.6,\n \"recycleFee\": 0\n },\n \"lines\": [\n {\n \"id\": 201045,\n \"lineNumber\": 1,\n \"productCode\": \"01\",\n \"rollItemNumber\": \"TEST3.5\",\n \"styleName\": \"AMERICANA - 12'\",\n \"colorName\": \"ADIRONDACK\",\n \"supplierName\": \"MASLAND\",\n \"quantity\": 240.0003,\n \"saleUnits\": \"SF\",\n \"freight\": 0,\n \"unitPrice\": 12.29,\n \"total\": 2949.6,\n \"isUseTaxLine\": false,\n \"notes\": \"\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": \"Reserved\",\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": [],\n \"workOrderLines\": [\n {\n \"lineNumber\": 1,\n \"areaName\": \"\",\n \"quantity\": 240.0003,\n \"rate\": 0.3889,\n \"notes\": \"\"\n }\n ]\n },\n {\n \"id\": 201046,\n \"lineNumber\": 2,\n \"productCode\": \"01\",\n \"rollItemNumber\": \"CG0036590002\",\n \"styleName\": \"AMERICANA - 12'\",\n \"colorName\": \"ADOBE\",\n \"supplierName\": \"MASLAND\",\n \"quantity\": 2999.9997,\n \"saleUnits\": \"SF\",\n \"freight\": 0,\n \"unitPrice\": 12.29,\n \"total\": 36870,\n \"isUseTaxLine\": false,\n \"notes\": \"\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": \"Reserved\",\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": [\n {\n \"id\": 14655,\n \"description\": \"file.pdf\",\n \"fileExtension\": \"pdf\"\n }\n ],\n \"workOrderLines\": [\n {\n \"lineNumber\": 2,\n \"areaName\": \"\",\n \"quantity\": 2999.9997,\n \"rate\": 0.3889,\n \"notes\": \"\"\n }\n ]\n },\n {\n \"id\": 201123,\n \"lineNumber\": 3,\n \"productCode\": \"01\",\n \"rollItemNumber\": \"TEST1.98\",\n \"styleName\": \"AMERICANA - 12'\",\n \"colorName\": \"ADIRONDACK\",\n \"supplierName\": \"MASLAND\",\n \"quantity\": 2760.0003,\n \"saleUnits\": \"SF\",\n \"freight\": 0,\n \"unitPrice\": 12.29,\n \"total\": 33920.4,\n \"isUseTaxLine\": false,\n \"notes\": \"\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": \"Reserved\",\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": [],\n \"workOrderLines\": [\n {\n \"lineNumber\": 3,\n \"areaName\": \"TEST AREA FOR API\",\n \"quantity\": 2760.0003,\n \"rate\": 3.4989,\n \"notes\": \"\"\n }\n ]\n }\n ],\n \"attachments\": [],\n \"storeSpecific\": null,\n \"isExportedToOrder\": false,\n \"quoteDate\": \"2020-09-16\",\n \"orderNumber\": \"\",\n \"orderDate\": \"2020-09-16\",\n \"deliveryDate\": \"\",\n \"dueDate\": \"\",\n \"closedDate\": \"\",\n \"billedDate\": \"\",\n \"completedDate\": \"\",\n \"billingGroup\": null,\n \"payment\": {\n \"paidDate\": \"\",\n \"paidAmount\": 0,\n \"balanceDue\": 80376.6\n }\n },\n \"detail\": null\n}"}],"_postman_id":"3b2895b6-5e73-4770-b811-f05302f64c62"},{"name":"Create Order","id":"2c25b9a9-4a57-4d71-8c40-440c0367cbe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"messageId","value":"MESSAGE_ID","description":"

Optional HTTP header that will allow for retrieval of a message not immediately processed by a store

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"987655\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2021-04-01\",\n \"estimatedDeliveryDate\": \"2021-05-04\",\n \"jobNumber\": \"XYZ123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"userOrderTypeId\": 3,\n \"serviceTypeId\": 1,\n \"contractTypeId\": 1,\n \"timeSlot\": 4,\n \"isOccupied\": false,\n \"phase\": \"1\",\n \"model\": \"The Base Model\",\n \"unit\": \"60\",\n \"tract\": \"Tract A\",\n \"block\": \"Block A\",\n \"lot\": \"Lot A\",\n \"lines\": [\n \t{\n \t\t\"productId\": 992048,\n \t\t\"colorId\": 7814430,\n \t\t\"quantity\": 12.00,\n \t\t\"priceLevel\": \"Price3\",\n \"lineGroupId\": 14\n \t}\n\t]\n}"},"url":"https://api.rfms.online/v2/order/create","description":"

\n
This method requires the \"Enterprise\" level of the API product. Requests from other level API accounts will return Unauthorized.
\n

In order to specify a non-web order, the following JSON must be included in the body of the request. Otherwise, a newly created order will be considered a Web Order.

{\n  \"category\": \"Order\"\n}\n\n

For Prosource users, ECProductId and ECColorId fields may be included instead of the default productId and colorId fields for adding lines. See Create Quote for a detailed example.

Billing Groups

To add a new billing group to a new order, provide a general description, as well as contact information (up to four contacts may be added) in the following format:

{\n\"billingGroup\": {\n        \"description\": \"Project 15 - 34 NW Blvd\",\n        \"contactList\": [\n            {\n                \"name\": \"Yevgeniy Zhakarov\",\n                \"phone\": \"432-223-1212\",\n                \"email\": \"yevgen@nextgen.com\",\n                \"other\": \"zhenya@flyingcarpets.com\"\n            },\n            {\n                \"name\": \"Alex Smith\",\n                \"phone\": \"000-000-0010\",\n                \"email\": \"smith@floor.com\"\n            },\n            {\n                \"name\": \"Leonard Bernstein\",\n                \"email\": \"lenny@classicalcarpets.com\"\n            },\n            {\n                \"name\": \"Vartan Nersisyan\",\n                \"phone\": \"333-222-1111\",\n                \"other\": \"vnersisyan@flyingcarpet.com\"\n            }\n        ]\n    }\n}\n\n

Each contact object may contain these optional fields: \"name\", \"phone\", \"email\", \"other\"

To create a new order and add an existing billing group to it, input the invoice number of an order that already contains the existing group, like the following example shows:

{\n    \"billingGroup\": {\n        \"parentOrder\": \"CG003616\"\n    }\n}\n\n

Adding Work Order Lines

When adding work order lines to a specific line, keep in mind that the quantity needs to match (or in the case of multiple work order lines - add up to) the total quantity as defined in the order line. See Example under Create Quote - Create Quote with Work Order Lines for more details on the structure of the request.

Handling Store Waiting Responses

In the event that the Create Order method is called, but the store is not responding, a result similar to the following example will be returned:

{\n    \"status\": \"waiting\",\n    \"result\": \"Store has not replied. Try again later with following message id\",\n    \"detail\": {\n        \"docId\": \"a11fbbb82ea34977bd3feabb36ca40eb\"\n    }\n}\n\n

Note the detail object contains the docId field. The value of this field is the message id that can be used in an HTTP header (See HEADERS) to later retrieve the details of that message.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","order","create"],"host":["api","rfms","online"],"query":[],"variable":[]}},"response":[{"id":"cf8ca94f-9d04-4bb2-9cfb-dbd7a9f21c8d","name":"Create Quote using referenced line","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"token","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"987654\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2019-07-01\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"lines\": [\n \t{\n \t\t\"productId\": 992048,\n \t\t\"colorId\": 7814430,\n \t\t\"quantity\": 12.00,\n \t\t\"priceLevel\": \"Price3\"\n \t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/quote/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?XFxNYWNcSG9tZVxEb2N1bWVudHNcQ29kZVxSRk1TXE1lYXN1cmVDbG91ZEFwaVxSZm1zUHVibGljQXBpXHYyXHF1b3RlXGNyZWF0ZQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 16 Nov 2019 03:27:50 GMT"},{"key":"Content-Length","value":"54"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"ES903428\",\n \"detail\": null\n}"},{"id":"fbb9dca4-8351-429a-8e63-cd34e141b458","name":"Create Quote using unreferenced line","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"token","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"987654\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2019-07-01\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"lines\": [\n \t{\n\t\t\t\"productCode\": \"02\",\n\t \"styleName\": \"CLASSIC SHAG\",\n\t \"colorName\": \"MELLOW YELLOW\",\n\t \"supplierName\": \"WILLIAMS\",\n\t \"saleUnits\": \"SY\",\n\t \"unitPrice\": 8.99,\n\t \"quantity\": 90,\n\t \"notes\": \"hello\",\n\t \"lineStatus\": \"None\"\n\t\t} \t\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/quote/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?XFxNYWNcSG9tZVxEb2N1bWVudHNcQ29kZVxSRk1TXE1lYXN1cmVDbG91ZEFwaVxSZm1zUHVibGljQXBpXHYyXHF1b3RlXGNyZWF0ZQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 16 Nov 2019 03:27:50 GMT"},{"key":"Content-Length","value":"54"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"ES903428\",\n \"detail\": null\n}"},{"id":"fa202bed-ae3f-4cff-b0d6-ea16a1300046","name":"Create a Non-Web Order Using Category Field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"token","type":"text","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n\t\"category\": \"Order\",\n \"poNumber\": \"987654\",\n \"quoteDate\": \"2020-06-01\",\n \"estimatedDeliveryDate\": \"2020-10-11\",\n \"jobNumber\": \"987ZEF\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"salesperson1\": \"JOHN\",\n \"lines\": [\n \t{\n \t\t\"productId\": 992048,\n \t\t\"colorId\": 7814430,\n \t\t\"quantity\": 12.00,\n \t\t\"priceLevel\": \"Price3\"\n \t}\n\t]\n}"},"url":"https://api.rfms.online/v2/order/create"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""},{"id":"4b9b70d0-9403-4b4c-af48-7f902f0c2efe","name":"Create Order and Set Order Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"token","type":"text","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"poNumber\": \"987655\",\n \"adSource\": \"BILLBOARD\",\n \"quoteDate\": \"2021-04-01\",\n \"estimatedDeliveryDate\": \"2021-05-04\",\n \"jobNumber\": \"XYZ123\",\n \"soldTo\": { \n\t \"lastName\": \"DOE\",\n\t \"firstName\": \"JOHN\",\n\t \"address1\": \"1234 MAIN ST\",\n\t \"address2\": \"STE 33\",\n\t \"city\": \"ANYTOWN\",\n\t \"state\": \"CA\",\n\t \"postalCode\": \"91332\",\n\t \"county\": \"LOS ANGELES\"\n },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"userOrderTypeId\": 3,\n \"serviceTypeId\": 1,\n \"contractTypeId\": 1,\n \"lines\": [\n \t{\n \t\t\"productId\": 992048,\n \t\t\"colorId\": 7814430,\n \t\t\"quantity\": 12.00,\n \t\t\"priceLevel\": \"Price3\"\n \t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"182"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 28 Apr 2021 21:36:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"CG105041\",\n \"detail\": {\n \"docId\": \"83692\"\n }\n}"}],"_postman_id":"2c25b9a9-4a57-4d71-8c40-440c0367cbe6"},{"name":"Update Order","id":"1873bcb2-8a53-46b1-9f9e-6aad72d8d5dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"number\": \"CG903368\",\n \"poNumber\": \"987654\",\n \"adSource\": \"BILLBOARD\",\n \"orderDate\": \"2019-07-01\",\n \"estimatedDeliveryDate\": \"2019-08-01\",\n \"jobNumber\": \"ABC123\",\n \"soldTo\": { \"customerType\": \"DECORATOR\" },\n \"storeNumber\": 50,\n \"privateNotes\": \"PRIVATE\",\n \"publicNotes\": \"PUBLIC\",\n \"workOrderNotes\": \"WORK ORDER NOTES\",\n \"salesperson1\": \"JOHN\",\n \"salesperson2\": \"FRANK\",\n \"userOrderTypeId\": 2,\n \"serviceTypeId\": 1,\n \"contractTypeId\": 1,\n \"timeSlot\": 3,\n \"isOccupied\": false,\n \"phase\": \"1\",\n \"model\": \"The Base Model\",\n \"unit\": \"50\",\n \"tract\": \"Tract A\",\n \"block\": \"Block A\",\n \"lot\": \"Lot A\"\n}"},"url":"https://api.rfms.online/v2/order","description":"

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Updating order lines

See the documentation for Update Quote for more information

Updating work order lines

See the documentation for Update Quote for more information

Billing Groups

See the documentation for Create Order for guidance on adding a new or existing billing group to an order.

\n
Note: Only non-Web Orders may be updated with a billing group.
\n

Append or add new notes to an order. This method can be used to update notes, even in the event that the order is already Job Costed.

\n
This method requires the \"Plus\" level of the API product
\n

Available Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Type	Meaning
number	true	string	Order (or claim if using /claim/notes endpoint) number
publicNotes	false	string	Text to append to the public note field
privateNotes	false	string	Text to append to the private note field
workOrderNotes	false	string	Text to append to the work order note field
lineNotes	false	array	An array of objects that allow for specifying a line to which to append notes. See example for exact formatting

Stand alone call to switch either a single line or multiple line statuses to and from None to GeneratePurchaseOrder.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required	Meaning
orderNumber	true	Number of order for which the line(s) will be updated
lineId	false	Integer. The line id. Line must have status of None or GenPO
lineIds	false	List of integers. All line ids must have a status of None or GenPO
setToGeneratePO	true	Boolean to switch the status between None and GenPO.

Search for orders.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required	Meaning
searchText	true	Given text will be found in customer first or customer last name.
dateCreatedFrom	false	Search for a quote that was created after this date.
dateCreatedTo	false	Search for a quote that was created before this date
salesperson1	false	Filter quotes by a certain salesperson
salesperson2	false	Filter based on a secondary salesperson
customerId	false	Search based on customer Id
viewBilledOnly	false	Filter orders based on billed status. If true, only billed orders will be returned
resultPageNumber	false	Specify a specific page of order results to view. By default, returns first page of results

\n
Note: Each page contains ten results from the query, starting from most recently created.
\n

Search for orders.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Notes	Required
searchText	Text found in customer first or last name, phone number, address, PO number, and job number	false
adSource	String value	false
orderSearchType	String value. Type of document for which to search. Options are Order, Quote, or Claim. Defaults to Order	false
orderType	Integer value from userOrderTypeId list found in the Get order values endpoint	false
contractType	Integer value from contractTypeId list found in the Get order values endpoint	false
serviceType	Integer value from serviceTypeId list found in the Get order values endpoint	false
stores	List of store numbers. Note: Need to specify at least one store to return valid search results	true
estimatedDeliveryFrom	String in YYYY-MM-DD format	false
estimatedDeliveryTo	String in YYYY-MM-DD format	false
orderDateFrom	String in YYYY-MM-DD format	false
orderDateTo	String in YYYY-MM-DD format	false
measureDateFrom	String in YYYY-MM-DD format	false
measureDateTo	String in YYYY-MM-DD format	false
deliveryDateFrom	String in YYYY-MM-DD format	false
deliveryDateTo	String in YYYY-MM-DD format	false
updatedDateFrom	Gets all new or updated orders starting from the specified date. String in YYYY-MM-DD format	false
scheduleProStatus	Integer value selected from the Get Job Status Ids endpoint	false

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","order","find","advanced"],"host":["api","rfms","online"],"query":[],"variable":[]}},"response":[{"id":"a5ddcdcb-945b-4a57-ad36-e35e662f54e4","name":"Advanced Order Search","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"searchText\": \"car\",\r\n \"stores\": [32, 50],\r\n \"estimatedDeliveryFrom\": \"2023-01-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/order/find/advanced"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"2040"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": [\n {\n \"id\": 84337,\n \"documentNumber\": \"WO394853\",\n \"customer\": {\n \"customerId\": 75515,\n \"phone1\": \"2055555556\",\n \"phone2\": \"\",\n \"email\": \"TEST@TEST.COM\",\n \"customerType\": \"RETAIL-INSTALL\",\n \"businessName\": null,\n \"lastName\": \"BANUELOS, CARLOS\",\n \"firstName\": null,\n \"address1\": \"555 TUSCALOOSA AVE\",\n \"address2\": \"\",\n \"city\": \"TUSCALOOSA\",\n \"state\": \"AL\",\n \"postalCode\": \"35405\",\n \"county\": \"TUSCALOOSA\"\n },\n \"shipTo\": {\n \"businessName\": null,\n \"lastName\": \"BANUELOS, CARLOS\",\n \"firstName\": null,\n \"address1\": \"1201 6TH AVE. NW\",\n \"address2\": \"\",\n \"city\": \"ALABASER\",\n \"state\": \"AL\",\n \"postalCode\": \"35007\",\n \"county\": \"ALABASER\"\n },\n \"deliveryDate\": \"\",\n \"poNumber\": \"\",\n \"invoiceType\": \"OriginalInvoice\",\n \"jobNumber\": \"\",\n \"orderDate\": \"2022-07-08\",\n \"estimatedDeliveryDate\": \"2023-02-15\",\n \"dateEntered\": \"2022-07-08\",\n \"adSource\": \"\",\n \"orderType\": \"\",\n \"contractType\": \"\",\n \"serviceType\": \"\",\n \"balanceDue\": 361.6,\n \"orderTotal\": 361.6,\n \"grandTotal\": 361.6,\n \"measureDate\": \"\",\n \"salesperson1\": \"CARLOS BANUELOS\",\n \"salesperson2\": \"\",\n \"store\": 32,\n \"paid\": 0,\n \"invoiceDate\": \"\",\n \"occupied\": false,\n \"closedDate\": \"\",\n \"voided\": false\n },\n {\n \"id\": 84509,\n \"documentNumber\": \"PM1023\",\n \"customer\": {\n \"customerId\": 75887,\n \"phone1\": \"2052062071\",\n \"phone2\": \"2059056051\",\n \"email\": \"CBANUELOS@TEST.COM\",\n \"customerType\": \"INSTALLER\",\n \"businessName\": null,\n \"lastName\": \"BANUELOS, CARLOS\",\n \"firstName\": null,\n \"address1\": \"3073 PALISADES CT.\",\n \"address2\": \"\",\n \"city\": \"TUSCALOOSA\",\n \"state\": \"AL\",\n \"postalCode\": \"35405\",\n \"county\": \"TUSCALOOSA\"\n },\n \"shipTo\": {\n \"businessName\": null,\n \"lastName\": \"CARLOS, BANUELOS\",\n \"firstName\": null,\n \"address1\": \"3074 PALISADES CT.\",\n \"address2\": \"\",\n \"city\": \"TUSCALOOSA\",\n \"state\": \"AL\",\n \"postalCode\": \"35405\",\n \"county\": \"TUSCALOOSA\"\n },\n \"deliveryDate\": \"\",\n \"poNumber\": \"\",\n \"invoiceType\": \"OriginalInvoice\",\n \"jobNumber\": \"\",\n \"orderDate\": \"2023-02-08\",\n \"estimatedDeliveryDate\": \"2023-01-12\",\n \"dateEntered\": \"2023-02-08\",\n \"adSource\": \"\",\n \"orderType\": \"\",\n \"contractType\": \"\",\n \"serviceType\": \"\",\n \"balanceDue\": 4409.6,\n \"orderTotal\": 4409.6,\n \"grandTotal\": 4409.6,\n \"measureDate\": \"\",\n \"salesperson1\": \"CARLOS BANUELOS\",\n \"salesperson2\": \"\",\n \"store\": 50,\n \"paid\": 0,\n \"invoiceDate\": \"\",\n \"occupied\": false,\n \"closedDate\": \"\",\n \"voided\": false\n }\n ],\n \"detail\": null\n}"}],"_postman_id":"9e0b04c8-efdf-4f96-b76e-d715d7cb133e"},{"name":"Get Order Gross Profit","id":"95d5e11d-ba9d-49fb-88ab-256c25af2017","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rfms.online/v2/order/grossprofit/CG003607","description":"

Given an order number, this method retrieves the gross profit, along with additional information.

\n
This method requires \"Plus\" level of API product at a minimum
\n

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Request master lists used to submit payments

Optional Http header that will allow for retrieval of a message not immediately processed by a store

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"documentNumber\": \"CG903367\",\n\t\"paymentMethod\": \"creditcard\",\n\t\"paymentAmount\": 10.00,\n\t\"approvalCode\": \"12345\",\n\t\"receiptAccountId\": 2,\n \"paymentFee\": 2.16,\n \"paymentReference\": \"ABA123\"\n}"},"url":"https://api.rfms.online/v2/payment","description":"

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Attach a record of payment to an existing quote or order.

Handling a Store Waiting Response

In the event that the Record Payment method is called, but the store is not responding, the request will return a result that looks similar to the following:

{\n    \"status\": \"waiting\",\n    \"result\": \"Store has not replied. Try again later with provided message id\",\n    \"detail\": \"a11fbbb82ea34977bd3feabb36ca40eb\"\n}\n

Note that the detail field contains, in this case, a messageId. This id can be used in an Http Header (See HEADERS and Example) to retrieve later the details of that message, once the store is able to process it.

Returns orders with a delivery date in the last 31 days and have been updated in the last 48 hours.

Search for purchase orders associated with a certain order and line number.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Given an order template with individual order lines, this method will return the applicable Sales Tax, Use Tax, and/or Misc Tax for given line total. For tax to be properly calculated, consult the table below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Explanation	Field Belongs To
shipTo	true	Fill out all relevant fields in accordance with city information	Order Object
productCode	See Meaning	Either include this field, or relevant product information. i.e productId, quantity, priceLevel	Line Object
lineTotal	true	Total dollar amount for goods/services for single line	Line Object
useLineTax	false	Set to true if line should be calculated as a UseTax line, and excluded from sales tax calculations	Line Object

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Given an order invoice number, this method returns a list of payments made on that order.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Retrieve a file attachment. The file is returned as a Base64 encoded string.

The id provided in the attachments collection returned by Get Quote or Get Order.

\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"cea6cb2c-7d45-4344-81a0-db45e6c6d36e","name":"Get Attachment","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.rfms.online/v2/attachment/14003"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"result\": \"OK\",\r\n \"detail\": \"** BASE64 ENCODED DATA **\"\r\n}"}],"_postman_id":"5f008ab9-b932-4af7-8f8e-332d97036d2e"},{"name":"Add Attachment","id":"0979c023-02d3-4d44-9e93-3d1ee3bebf8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.rfms.online/v2/attachment","description":"

Add an attachment to a document or a product

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

The following table details the parameters required, if the user wishes to add an attachment to a quote:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Meaning
documentNumber	string	true	Number of document to which attachment is to be added
documentType	string	true	Specify if this document is a Quote, Order, Estimate, or Claim
lineNumber	number	false	If adding attachment to specific quote/order line, specify using this parameter
fileExtension	string	true	File extension of attachment (jpg,pdf,etc)
description	string	false	Brief description of attachment contents
fileData	string	true	Base64 encoded string representing the file
paperlessDocType	int	false	Document type id obtained from Get Paperless Document Types endpoint
subNumber	int	false	The estimate sub number. Defaults to 1. Only applies to adding an attachment to an estimate.

If the user wishes to add an attachment to a product, then the following parameters shall be used:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Meaning
productId	number	true	Id of the product to which the attachment will be added
fileExtension	string	true	File extension of attachment (jpg,pdf,etc)
description	string	false	Brief description of attachment contents
fileData	string	true	Base64 encoded string representing the file
paperlessDocType	int	false	Document type id obtained from Get Paperless Document Types endpoint

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Gets a list of paperless document types for a specific user, or the default list if no user is provided.

Group can be one of the following values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Group	Explanation
RollProductColor	Roll Product Color
ItemProductColor	Product Item Color
ServicePictures	Service Record
HeaderPictures	Order Header
LinePictures	Order Line
EstHeadPictures	Quote Header
EstLinePictures	Quote Line
ClaimHeadPictures	Claim Header
ClaimLinePictures	Claim Line
JeHeadPictures	BidPro Estimate Header
JeLinePictures	BidPro Estimate Line
RollInventory	Roll Inventory Record
ItemInventory	Item Inventory Record
RollProduct	Roll Product Record
ItemProduct	Item Product Record

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Finds attachments based on a variety of user-provided parameters. Said parameter options are defined below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attachment Type	Required Parameters	Optional Parameters	Notes
Quote Header Order Header Estimate Header	documentNumber documentType	subNumber (Estimate only)	documentType = \"Quote\" documentType = \"Order\" documentType = \"Estimate\"
Quote Line Order Line Estimate Line	documentNumber documentType lineNumber	subNumber (Estimate only)	Same as above
Roll Good Item	productId
Roll Good Inventory Item Inventory	productId isInventory		isInventory must be set to true
Roll Good Color Item Color	productId colorId
Service	productId isService		isService must be set to true

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Given an attachment id, this method will delete the associated attachment.

Retrieve a specific estimate

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Estimate sub number. Defaults to 1.

\n","type":"text/plain"},"key":"subNumber","value":null}],"variable":[{"description":{"content":"

Specific estimate from which to retrieve details

\n","type":"text/plain"},"type":"string","value":"","key":"number"}]}},"response":[{"id":"d820cb23-d39f-4e4b-9225-74c137495400","name":"Get Estimate","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rfms.online/v2/estimate/:number?subNumber=1","protocol":"https","host":["api","rfms","online"],"path":["v2","estimate",":number"],"query":[{"key":"subNumber","value":"1","description":"Default value is 1."}],"variable":[{"key":"number","value":"JE100250","description":"Specific estimate from which to retrieve details "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1546"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 16 Jul 2020 22:57:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"id\": \"4875\",\n \"number\": \"JE100250\",\n \"subNumber\": 1,\n \"originalNumber\": \"\",\n \"category\": \"\",\n \"soldTo\": {\n \"customerId\": 373,\n \"phone1\": \"\",\n \"phone2\": \"\",\n \"email\": \"\",\n \"customerType\": \"CASH & CARRY\",\n \"businessName\": null,\n \"lastName\": \"\",\n \"firstName\": \"NANCY\",\n \"address1\": \"17557 GOLD FINCH DRIVE\",\n \"address2\": \"\",\n \"city\": \"BUHL\",\n \"state\": \"AL\",\n \"postalCode\": \"35446-\",\n \"county\": \"\"\n },\n \"shipTo\": {\n \"businessName\": null,\n \"lastName\": \"SMITH\",\n \"firstName\": \"NANCY\",\n \"address1\": \"17557 GOLD FINCH DRIVE\",\n \"address2\": \"\",\n \"city\": \"BUHL\",\n \"state\": \"AL\",\n \"postalCode\": \"35446-\",\n \"county\": \"\"\n },\n \"salesperson1\": \"ANDREW\",\n \"salesperson2\": \"\",\n \"salespersonSplitPercent\": 0,\n \"storeCode\": null,\n \"storeNumber\": 32,\n \"jobNumber\": \"\",\n \"poNumber\": \"\",\n \"privateNotes\": \"\",\n \"publicNotes\": \"\",\n \"workOrderNotes\": \"\",\n \"estimatedDeliveryDate\": \"2016-05-13\",\n \"enteredDate\": \"\",\n \"measureDate\": \"2016-05-13\",\n \"taxStatus\": \"Tax\",\n \"taxMethod\": null,\n \"adSource\": null,\n \"userOrderTypeId\": 0,\n \"serviceTypeId\": 0,\n \"contractTypeId\": 0,\n \"totals\": {\n \"material\": 2547.36,\n \"labor\": 920.36,\n \"misc\": 0,\n \"total\": 3467.72,\n \"salesTax\": 0,\n \"miscTax\": 0,\n \"grandTotal\": 3467.72,\n \"recycleFee\": 0\n },\n \"lines\": [\n {\n \"id\": 14287,\n \"lineNumber\": 1,\n \"productCode\": \"01\",\n \"rollItemNumber\": null,\n \"styleName\": \"CALL TO THE POST\",\n \"colorName\": \"BEFORE DARK\",\n \"supplierName\": \"RFMS\",\n \"quantity\": 732,\n \"saleUnits\": \"SF\",\n \"freight\": 0.06,\n \"unitPrice\": 2.79,\n \"total\": 2042.28,\n \"isUseTaxLine\": false,\n \"notes\": \"COMBINED AREAS:\\rCUT GROUP 1 (MASTER BEDROOM,BED 3) QTY: 358 SF\\nCUT GROUP 2 (BED 2,MASTER BEDROOM,BED 3) QTY: 374 SF\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": null,\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": []\n },\n {\n \"id\": 14290,\n \"lineNumber\": 4,\n \"productCode\": \"81\",\n \"rollItemNumber\": null,\n \"styleName\": \"HEALTHIER LIVING-(BASIC)\",\n \"colorName\": \"\",\n \"supplierName\": \"\",\n \"quantity\": 732,\n \"saleUnits\": \"SF\",\n \"freight\": 0,\n \"unitPrice\": 0.72,\n \"total\": 527.04,\n \"isUseTaxLine\": false,\n \"notes\": \"(SHEET-LEVEL)\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": null,\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": []\n },\n {\n \"id\": 14291,\n \"lineNumber\": 5,\n \"productCode\": \"84\",\n \"rollItemNumber\": null,\n \"styleName\": \"TAKEUP GLUED CPT\",\n \"colorName\": \"\",\n \"supplierName\": \"\",\n \"quantity\": 627.74,\n \"saleUnits\": \"SF\",\n \"freight\": 0,\n \"unitPrice\": 0.3,\n \"total\": 188.32,\n \"isUseTaxLine\": false,\n \"notes\": \"(SHEET-LEVEL)\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": null,\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": []\n },\n {\n \"id\": 14288,\n \"lineNumber\": 2,\n \"productCode\": \"04\",\n \"rollItemNumber\": null,\n \"styleName\": \"BRONZE-BASIC\",\n \"colorName\": \"3.5# REBOND-7/16\\\"\",\n \"supplierName\": \"CARPENTER\",\n \"quantity\": 732,\n \"saleUnits\": \"SF\",\n \"freight\": 0.01,\n \"unitPrice\": 0.69,\n \"total\": 505.08,\n \"isUseTaxLine\": false,\n \"notes\": \"(SHEET-LEVEL)\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": null,\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": []\n },\n {\n \"id\": 14289,\n \"lineNumber\": 3,\n \"productCode\": \"80\",\n \"rollItemNumber\": null,\n \"styleName\": \"MOVE FURNITURE\",\n \"colorName\": \"\",\n \"supplierName\": \"\",\n \"quantity\": 2,\n \"saleUnits\": \"HR\",\n \"freight\": 0,\n \"unitPrice\": 102.5,\n \"total\": 205,\n \"isUseTaxLine\": false,\n \"notes\": \"(SHEET-LEVEL)\",\n \"productId\": 0,\n \"colorId\": 0,\n \"delete\": false,\n \"priceLevel\": null,\n \"lineStatus\": null,\n \"inTransit\": false,\n \"promiseDate\": \"\",\n \"attachments\": []\n }\n ],\n \"attachments\": [\n {\n \"id\": 7037,\n \"description\": \"Room Plan 5/13/2016 11:35AM\",\n \"fileExtension\": \"jpg \"\n },\n {\n \"id\": 7038,\n \"description\": \"Seam Plan 5/13/2016 11:35AM\",\n \"fileExtension\": \"jpg \"\n },\n {\n \"id\": 7039,\n \"description\": \"Cut Plan (Page 1) 5/13/2016 11:35AM\",\n \"fileExtension\": \"jpg\"\n },\n {\n \"id\": 7040,\n \"description\": \"Cut Plan (Page 2) 5/13/2016 11:35AM\",\n \"fileExtension\": \"jpg\"\n }\n ],\n \"storeSpecific\": null,\n \"isExportedToOrder\": false,\n \"quoteDate\": \"2016-05-13\",\n \"orderNumber\": \"\",\n \"orderDate\": \"2016-05-13\",\n \"deliveryDate\": \"\",\n \"dueDate\": \"\",\n \"closedDate\": \"\",\n \"billedDate\": \"\",\n \"completedDate\": \"\",\n \"billingGroup\": null,\n \"payment\": {\n \"paidDate\": \"\",\n \"paidAmount\": 0,\n \"balanceDue\": 0\n }\n },\n \"detail\": null\n}"}],"_postman_id":"699bc172-8a75-46f9-a375-7f19d04863b2"},{"name":"Create Estimate","id":"a24557f4-8497-4196-81e0-6a9cc76d6fc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"poNumber\": \"00504\",\r\n \"measureDate\": \"2021-03-01\",\r\n \"estimatedDeliveryDate\": \"2021-03-29\",\r\n \"jobNumber\": \"WERS997\",\r\n \"soldTo\": {\r\n \"lastName\": \"Orwell\",\r\n \"firstName\": \"George\",\r\n \"address1\": \"77 Almaz BLVD\",\r\n \"address2\": \"STE 101\",\r\n \"city\": \"NOWHERE\",\r\n \"state\": \"NE\",\r\n \"postalCode\": \"56332\",\r\n \"phone1\": \"403-333-1000\",\r\n \"email\": \"gorwell1@dystopiancoverings.com\",\r\n \"customerType\": \"REMODELING\"\r\n },\r\n \"shipTo\":\r\n {\r\n \"lastName\": \"Orwell\",\r\n \"firstName\": \"George\",\r\n \"address1\": \"77 Almaz BLVD\",\r\n \"address2\": \"STE 102\",\r\n \"city\": \"NOWHERE\",\r\n \"state\": \"NE\",\r\n \"postalCode\": \"56332\"\r\n },\r\n \"storeNumber\": 32,\r\n \"privateNotes\": \"PRIVATE - ORDER DELAYED\",\r\n \"publicNotes\": \"PUBLIC\",\r\n \"salesperson1\": \"Igor\",\r\n \"lines\": [\r\n \t{\r\n \t\t\"productId\": 1018473,\r\n \t\t\"colorId\": 8173202,\r\n \t\t\"quantity\": 17.00,\r\n \t\t\"priceLevel\": \"Price3\"\r\n \t},\r\n {\r\n \"productId\": 988660,\r\n \"colorId\": 7792812,\r\n \"quantity\": 56.00,\r\n \"priceLevel\": \"Price1\"\r\n }\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/estimate/create","description":"

Create a BidPro estimate. The same fields for creating a quote may be used to populate estimate information.

Sub Number

An estimate sub number can be specified. If not included, it will default to 1. To create an estimate with a sub number greater than 1, include the documentNumber field in the body of the request, in addition to the subNumber field.

\n
This method requires the \"Enterprise\" level of the API product
\n

All elements other than number are optional. Similar to updating quotes, only include the elements you wish to modify. To update an estimate with a particular sub number, include the subNumber field. If no subNumber is included, the default will be 1.

\n
This method requires the \"Enterprise\" level of the API product
\n

Search for Estimates.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required	Meaning
searchText	true	Text searches across customer first name, customer last name, estimate number, project name, model, salesperson1, and salesperson2
dateCreatedFrom	false	Search for an estimate that was created after this date.
dateCreatedTo	false	Search for an estimate that was created before this date
viewExportedOnly	false	Filters estimates by export status.
viewOpenOnly	false	Filters estimates by export status.
resultPageNumber	false	Specify a specific page of estimate results to view. By default, returns first page of results

\n
Note: Each page contains ten results from the query, starting from most recently created.
\n

\n
This method requires the \"Enterprise\" level of the API product. Requests from other level API accounts will return Unauthorized.
\n

Append or add new notes to a claim. Refer to Add Notes To Order documentation to view all available parameters for updating note fields.

\n
This method requires the \"Plus\" level of the API product
\n

This call returns a list of product codes defined for a store.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Given an array containing one or more product IDs, this request returns detailed information about each respective product.

\n
This method requires \"Plus\" level of API product at a minimum
\n

Test note on Product Style

\",\n \"inventoryUnits\": \"\",\n \"priceListings\": {\n \"Price1\": 5.59,\n \"Price2\": 3.12,\n \"Price3\": 2.58,\n \"Price4\": 2.36,\n \"Price5\": 2.3,\n \"Price8\": 8.38,\n \"Price9\": 3.4,\n \"Price10\": 8.48,\n \"Price11\": 3.5,\n \"Price12\": 1.57,\n \"Cut\": 1.57,\n \"Roll\": 1.43\n },\n \"colorOptions\": [\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161697\",\n \"colorName\": \"ATLANTIC BLUE\",\n \"colorNumber\": \"105\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161698\",\n \"colorName\": \"BLACKTOP\",\n \"colorNumber\": \"106\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161693\",\n \"colorName\": \"BRIARWOOD\",\n \"colorNumber\": \"101\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161702\",\n \"colorName\": \"CAROLINA BLOSSO\",\n \"colorNumber\": \"70801\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161703\",\n \"colorName\": \"ETERNAL JEWEL\",\n \"colorNumber\": \"111\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161692\",\n \"colorName\": \"FRANKLIN GREEN\",\n \"colorNumber\": \"100\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161696\",\n \"colorName\": \"FROZEN LAKE\",\n \"colorNumber\": \"104\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161701\",\n \"colorName\": \"PARADISE BEACH\",\n \"colorNumber\": \"109\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161704\",\n \"colorName\": \"PURPLE DREAM\",\n \"colorNumber\": \"112\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161695\",\n \"colorName\": \"QUINTON EVERGRE\",\n \"colorNumber\": \"70304\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161694\",\n \"colorName\": \"TIDEWATER\",\n \"colorNumber\": \"102\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161699\",\n \"colorName\": \"TUSCANY\",\n \"colorNumber\": \"107\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"1161700\",\n \"colorName\": \"WESTSIDE\",\n \"colorNumber\": \"108\",\n \"SKU\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"id\": 12345,\n \"description\": \"Red.jpg\",\n \"fileExtension\": \"jpg\",\n \"url\": \"\"\n }\n ],\n \"id\": \"88419\",\n \"productCode\": \"01\",\n \"storeNumber\": 32,\n \"styleName\": \"COPIOUS - 12'\",\n \"styleNumber\": \"10100871\",\n \"defaultPrice\": 0,\n \"saleUnits\": \"SF\",\n \"rollWidthInInches\": 144,\n \"patternWidthInInches\": 0,\n \"patternLengthInInches\": 0\n },\n {\n \"rollNumber\": \"\",\n \"supplierName\": \"KRAUS CARPET MILLS LIMITED\",\n \"privateSupplierName\": \"CARPET ONE\",\n \"manufacturerName\": \"KRAUS CARPET MILLS LIMITED\",\n \"rollLengthInches\": 0,\n \"activeProduct\": true,\n \"sellByQuantity\": 0,\n \"inventoryUnits\": \"\",\n \"priceListings\": {\n \"Cut\": 0,\n \"Roll\": 0\n },\n \"colorOptions\": [\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227105\",\n \"colorName\": \"FAIRY MOSS\",\n \"colorNumber\": \"79\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227109\",\n \"colorName\": \"FATISIA\",\n \"colorNumber\": \"29\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227107\",\n \"colorName\": \"FELICITA\",\n \"colorNumber\": \"76\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227096\",\n \"colorName\": \"FELT\",\n \"colorNumber\": \"81\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227101\",\n \"colorName\": \"FENNEL\",\n \"colorNumber\": \"10\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227110\",\n \"colorName\": \"FETTERBUSH\",\n \"colorNumber\": \"14\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227102\",\n \"colorName\": \"FILBERT\",\n \"colorNumber\": \"32\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227108\",\n \"colorName\": \"FILLY CURLS\",\n \"colorNumber\": \"07\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227112\",\n \"colorName\": \"FLEECE\",\n \"colorNumber\": \"54\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227099\",\n \"colorName\": \"FOAMFLOWER\",\n \"colorNumber\": \"80\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227094\",\n \"colorName\": \"FOGGY\",\n \"colorNumber\": \"90\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227097\",\n \"colorName\": \"FOLKLORE\",\n \"colorNumber\": \"48\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227100\",\n \"colorName\": \"FORGET-ME-NOT\",\n \"colorNumber\": \"83\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227111\",\n \"colorName\": \"FOSTER\",\n \"colorNumber\": \"41\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227103\",\n \"colorName\": \"FOUNTAIN GRASS\",\n \"colorNumber\": \"50\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227106\",\n \"colorName\": \"FOXTAIL\",\n \"colorNumber\": \"82\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227104\",\n \"colorName\": \"FRAGMENT\",\n \"colorNumber\": \"91\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227098\",\n \"colorName\": \"FRANKLINIA\",\n \"colorNumber\": \"58\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227113\",\n \"colorName\": \"FREESIAS\",\n \"colorNumber\": \"77\",\n \"SKU\": \"\"\n },\n {\n \"relatedProductAvailable\": false,\n \"activeColor\": true,\n \"attactments\": [],\n \"id\": \"8227095\",\n \"colorName\": \"FRENCH LACE\",\n \"colorNumber\": \"78\",\n \"SKU\": \"\"\n }\n ],\n \"id\": \"1021622\",\n \"productCode\": \"01\",\n \"storeNumber\": 32,\n \"styleName\": \"FLORET - 12'\",\n \"styleNumber\": \"2013\",\n \"defaultPrice\": 0,\n \"saleUnits\": \"SF\",\n \"rollWidthInInches\": 144,\n \"patternWidthInInches\": 0,\n \"patternLengthInInches\": 0\n }\n ],\n \"detail\": [\n {\n \"patternDropFraction\": 0,\n \"cutGapInInches\": 4,\n \"cutGapMethod\": 0,\n \"allowedTseams\": 2,\n \"cutSquare\": true,\n \"extraWastePercent\": 18,\n \"unitCost\": 1.04,\n \"supplier\": \"SHAW INDUSTRIES, INC\",\n \"privateSupplier\": \"CARPET ONE\",\n \"manufacturer\": \"PHILADELPHIA MAINSTR 40\",\n \"sellQuantity\": 0,\n \"inventoryUnit\": \"\",\n \"rollNumber\": \"\",\n \"rollLengthInInches\": 2400,\n \"active\": true,\n \"colors\": [\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157177\",\n \"colorName\": \"BANK BAG\",\n \"colorNumber\": \"106\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157172\",\n \"colorName\": \"BANKER S PINSTR\",\n \"colorNumber\": \"68401\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157170\",\n \"colorName\": \"CASH FLOW\",\n \"colorNumber\": \"108\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157178\",\n \"colorName\": \"COIN WRAPPER\",\n \"colorNumber\": \"109\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157169\",\n \"colorName\": \"CURRENCY\",\n \"colorNumber\": \"110\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157179\",\n \"colorName\": \"DAY TRADER\",\n \"colorNumber\": \"111\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157182\",\n \"colorName\": \"DIVIDEND\",\n \"colorNumber\": \"112\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157166\",\n \"colorName\": \"DOLLAR SIGN\",\n \"colorNumber\": \"113\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157165\",\n \"colorName\": \"FRANKLIN MINT\",\n \"colorNumber\": \"114\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157180\",\n \"colorName\": \"IN THE RED\",\n \"colorNumber\": \"100\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157168\",\n \"colorName\": \"INTEREST RATE\",\n \"colorNumber\": \"115\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157171\",\n \"colorName\": \"LADY LIBERTY\",\n \"colorNumber\": \"116\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157176\",\n \"colorName\": \"LOOSE CHANGE\",\n \"colorNumber\": \"117\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157181\",\n \"colorName\": \"MUTUAL FUND\",\n \"colorNumber\": \"104\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157173\",\n \"colorName\": \"NIGHT DEPOSIT\",\n \"colorNumber\": \"105\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157167\",\n \"colorName\": \"PRESIDENT S DAY\",\n \"colorNumber\": \"68302\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157175\",\n \"colorName\": \"SILVER DOLLAR\",\n \"colorNumber\": \"102\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1157174\",\n \"colorName\": \"STOCK MARKET\",\n \"colorNumber\": \"103\"\n }\n ],\n \"id\": \"88168\",\n \"productCode\": \"01\",\n \"storeId\": 32,\n \"styleNumber\": \"5498029\",\n \"styleName\": \"EARNEST - 12'\",\n \"supplierName\": \"SHAW INDUSTRIES, INC\",\n \"manufacturerName\": \"PHILADELPHIA MAINSTR 40\",\n \"defaultPrice\": 2.12,\n \"defaultPriceLevel\": 2,\n \"saleUnits\": \"SF\",\n \"rollWidthInInches\": 144,\n \"patternWidthInInches\": 0,\n \"patternLengthInInches\": 0,\n \"prices\": {\n \"Price1\": 3.79,\n \"Price2\": 2.12,\n \"Price3\": 1.74,\n \"Price4\": 1.59,\n \"Price5\": 1.55,\n \"Price8\": 5.68,\n \"Price9\": 2.31,\n \"Price10\": 5.78,\n \"Price11\": 2.41,\n \"Price12\": 1.04,\n \"Cut\": 1.04,\n \"Roll\": 0.92\n }\n },\n {\n \"patternDropFraction\": 0,\n \"cutGapInInches\": 4,\n \"cutGapMethod\": 0,\n \"allowedTseams\": 2,\n \"cutSquare\": true,\n \"extraWastePercent\": 18,\n \"unitCost\": 1.57,\n \"supplier\": \"SHAW INDUSTRIES, INC\",\n \"privateSupplier\": \"CARPET ONE\",\n \"manufacturer\": \"PHILADELPHIA MAINSTR 40\",\n \"sellQuantity\": 0,\n \"inventoryUnit\": \"\",\n \"rollNumber\": \"\",\n \"rollLengthInInches\": 2400,\n \"active\": true,\n \"colors\": [\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161697\",\n \"colorName\": \"ATLANTIC BLUE\",\n \"colorNumber\": \"105\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161698\",\n \"colorName\": \"BLACKTOP\",\n \"colorNumber\": \"106\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161693\",\n \"colorName\": \"BRIARWOOD\",\n \"colorNumber\": \"101\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161702\",\n \"colorName\": \"CAROLINA BLOSSO\",\n \"colorNumber\": \"70801\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161703\",\n \"colorName\": \"ETERNAL JEWEL\",\n \"colorNumber\": \"111\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161692\",\n \"colorName\": \"FRANKLIN GREEN\",\n \"colorNumber\": \"100\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161696\",\n \"colorName\": \"FROZEN LAKE\",\n \"colorNumber\": \"104\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161701\",\n \"colorName\": \"PARADISE BEACH\",\n \"colorNumber\": \"109\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161704\",\n \"colorName\": \"PURPLE DREAM\",\n \"colorNumber\": \"112\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161695\",\n \"colorName\": \"QUINTON EVERGRE\",\n \"colorNumber\": \"70304\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161694\",\n \"colorName\": \"TIDEWATER\",\n \"colorNumber\": \"102\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161699\",\n \"colorName\": \"TUSCANY\",\n \"colorNumber\": \"107\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"1161700\",\n \"colorName\": \"WESTSIDE\",\n \"colorNumber\": \"108\"\n }\n ],\n \"id\": \"88419\",\n \"productCode\": \"01\",\n \"storeId\": 32,\n \"styleNumber\": \"10100871\",\n \"styleName\": \"COPIOUS - 12'\",\n \"supplierName\": \"SHAW INDUSTRIES, INC\",\n \"manufacturerName\": \"PHILADELPHIA MAINSTR 40\",\n \"defaultPrice\": 3.12,\n \"defaultPriceLevel\": 2,\n \"saleUnits\": \"SF\",\n \"rollWidthInInches\": 144,\n \"patternWidthInInches\": 0,\n \"patternLengthInInches\": 0,\n \"prices\": {\n \"Price1\": 5.59,\n \"Price2\": 3.12,\n \"Price3\": 2.58,\n \"Price4\": 2.36,\n \"Price5\": 2.3,\n \"Price8\": 8.38,\n \"Price9\": 3.4,\n \"Price10\": 8.48,\n \"Price11\": 3.5,\n \"Price12\": 1.57,\n \"Cut\": 1.57,\n \"Roll\": 1.43\n }\n },\n {\n \"patternDropFraction\": 0,\n \"cutGapInInches\": 4,\n \"cutGapMethod\": 0,\n \"allowedTseams\": 2,\n \"cutSquare\": true,\n \"extraWastePercent\": 18,\n \"unitCost\": 0,\n \"supplier\": \"KRAUS CARPET MILLS LIMITED\",\n \"privateSupplier\": \"CARPET ONE\",\n \"manufacturer\": \"KRAUS CARPET MILLS LIMITED\",\n \"sellQuantity\": 0,\n \"inventoryUnit\": \"\",\n \"rollNumber\": \"\",\n \"rollLengthInInches\": 0,\n \"active\": true,\n \"colors\": [\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227105\",\n \"colorName\": \"FAIRY MOSS\",\n \"colorNumber\": \"79\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227109\",\n \"colorName\": \"FATISIA\",\n \"colorNumber\": \"29\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227107\",\n \"colorName\": \"FELICITA\",\n \"colorNumber\": \"76\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227096\",\n \"colorName\": \"FELT\",\n \"colorNumber\": \"81\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227101\",\n \"colorName\": \"FENNEL\",\n \"colorNumber\": \"10\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227110\",\n \"colorName\": \"FETTERBUSH\",\n \"colorNumber\": \"14\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227102\",\n \"colorName\": \"FILBERT\",\n \"colorNumber\": \"32\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227108\",\n \"colorName\": \"FILLY CURLS\",\n \"colorNumber\": \"07\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227112\",\n \"colorName\": \"FLEECE\",\n \"colorNumber\": \"54\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227099\",\n \"colorName\": \"FOAMFLOWER\",\n \"colorNumber\": \"80\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227094\",\n \"colorName\": \"FOGGY\",\n \"colorNumber\": \"90\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227097\",\n \"colorName\": \"FOLKLORE\",\n \"colorNumber\": \"48\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227100\",\n \"colorName\": \"FORGET-ME-NOT\",\n \"colorNumber\": \"83\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227111\",\n \"colorName\": \"FOSTER\",\n \"colorNumber\": \"41\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227103\",\n \"colorName\": \"FOUNTAIN GRASS\",\n \"colorNumber\": \"50\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227106\",\n \"colorName\": \"FOXTAIL\",\n \"colorNumber\": \"82\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227104\",\n \"colorName\": \"FRAGMENT\",\n \"colorNumber\": \"91\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227098\",\n \"colorName\": \"FRANKLINIA\",\n \"colorNumber\": \"58\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227113\",\n \"colorName\": \"FREESIAS\",\n \"colorNumber\": \"77\"\n },\n {\n \"relatedProductAvailable\": false,\n \"sku\": \"\",\n \"active\": true,\n \"attachments\": [],\n \"id\": \"8227095\",\n \"colorName\": \"FRENCH LACE\",\n \"colorNumber\": \"78\"\n }\n ],\n \"id\": \"1021622\",\n \"productCode\": \"01\",\n \"storeId\": 32,\n \"styleNumber\": \"2013\",\n \"styleName\": \"FLORET - 12'\",\n \"supplierName\": \"KRAUS CARPET MILLS LIMITED\",\n \"manufacturerName\": \"KRAUS CARPET MILLS LIMITED\",\n \"defaultPrice\": 0,\n \"defaultPriceLevel\": 0,\n \"saleUnits\": \"SF\",\n \"rollWidthInInches\": 144,\n \"patternWidthInInches\": 12,\n \"patternLengthInInches\": 21,\n \"prices\": {\n \"Cut\": 0,\n \"Roll\": 0\n }\n }\n ]\n}"}],"_postman_id":"9c258350-885e-49fa-b146-c93b8d310453"},{"name":"Find Products","event":[{"listen":"test","script":{"id":"d2e935d1-0630-411f-899f-feb60a3acb80","exec":["var jsonData = JSON.parse(responseBody);\r","\r","tests[\"Status code is 200\"] = responseCode.code === 200;\r","tests[\"Request is accepted\"] = jsonData.accepted;\r","postman.setEnvironmentVariable(\"lastMessage\", jsonData.requestId);\r","\r",""],"type":"text/javascript"}}],"id":"f1920beb-08fd-4de1-afe8-c0d041d85b36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"searchText\": \"adobe\",\n \"storeNumber\": 32,\n \"productCode\": \"01\",\n \"ecProductId\": \"123AB\"\n}"},"url":"https://api.rfms.online/v2/product/find","description":"

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Search for products to include in quotes and orders.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Meaning
searchText	true	The supplied text will be found in the style name and color names for the product
productCode	false	Limit search to only products in a specific product code
storeNumber	false	If supplied, results will be filtered to only those in this store
colorSKU	false	Search for a specific color SKU
pageIndex	false	Results are returned 10 at a time. If this value is omitted (or set to 0) the first 10 are returned. To request the next page of 10, send pageIndex = 1, etc.
ecProductId	false	Search for products with certain ECProductID
ecColorId	false	Search for products with specified ECColorID
ecSizeId	false	Search for products with specified ECSizeID

Given a product ID and a color ID, this request will retrieve all associated product bundles. The response will also contain, for all products in each assoicated bundle, detailed product information. If color ID is left blank, the default behavior is to return all associated product bundles across all colors.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Given a product code, this request will return all associated templates, including detailed product information for all products contained in each returned template.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

This method retrieves all product etag records associated with a company.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

This method will allow you to check the available inventory for a product. Supply the productCode, styleName, and colorName exactly as they appear on the product record and you will receive one or more instances of the product in inventory.

If you would like to reserve or cut inventory, take note of the inventoryLink value returned. That value is supplied to the /order/inventory methods to actually assign the inventory to an order line.

\n
This method requires the \"Enterprise\" level of the API product. Requests from other level API accounts will return Unauthorized.
\n

This method reserves inventory for a line on an existing order. Supply the order number, line number, and the inventoryLink value. This value can be found by using the /product/inventorycheck method to find available inventory for the item.

Reserving for Multiple Order Lines

To reserve inventory for multiple lines of an existing order in a single request, omit lineNumber and inventoryLink fields from the main body of the request. Instead, these values should be placed inside a list of objects; one object for each order line the user wishes to modify. The following example illustrates this:

{\n    \"orderNumber\": \"CG003646\",\n    \"inventoryList\": [\n        {\n            \"lineNumber\": 1,\n            \"inventoryLink\": {\n                \"inventoryId\": 0,\n                \"rollNumber\": \"35112072\"\n            }\n        },\n        {\n            \"lineNumber\": 2,\n            \"inventoryLink\": {\n                \"inventoryId\": 0,\n                \"rollNumber\": \"244190K\"\n            }\n        },\n        {\n            \"lineNumber\": 3,\n            \"inventoryLink\": {\n                \"inventoryId\": 0,\n                \"rollNumber\": \"49265195\"\n            }\n        }\n    ]\n}\n

\n
This method requires the \"Enterprise\" level of the API product. Requests from other level API accounts will return Unauthorized.
\n

This method cuts inventory for a line on an existing order. Supply the order number, line number, and the inventoryLink value. This value can be found by using the /product/inventorycheck method to find available inventory for the item.

Cutting for Multiple Order Lines

To cut inventory for multiple lines of an existing order in a single request, follow the instructions as outlined in the Reserve Inventory request, under the subheading entitled: Reserving for Multiple Order Lines

The only difference will be the request itself.

This method stages either one or multiple lines on an order. Please note that this endpoint is for ERRM orders only.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required	Meaning
orderNumber	true	String. Order number.
orderDate	true	Formatted date string. Date to mark the lines as staged.
lines	true	List of integers. The number of the line to mark as staged.

This method delivers either one or multiple lines on an order.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required	Meaning
orderNumber	true	String. Order number.
orderDate	true	Formatted date string. Date to mark the lines as delivered.
lines	true	List of integers. The number of the line to mark as delivered.

Move inventory to a new bin location.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Notes
productCode	String value.
location	String value. The bin location to which the inventory item will be moved.
id	Integer value. The System Reference Number of the inventory item.

Retrieves visible and default store(s) for a salesperson by name.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

\n
This method requires the \"Enterprise\" level of the API product.
\n

Given the following parameters, this method creates a provider record from an order line.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Description
documentNumber	true	Order number from which to generate the provider record
lineNumber	true	Line number of the order
installDate	true	Line install date
supplierId	See Description	Id of supplier, provide this value, or the value below
providerId	See Description	Id of provider. Supply this value, or the value above
rate	false	Overrides rate. Defaults to line gross cost or personnel hourly rate
hoursRegular	false	Decimal value
hoursOvertime	false	Decimal value
hoursDoubleTime	false	Decimal value

Note: Obtain the supplierId and providerId from the following public API methods: Get Suppliers, Get Personnel

\n
This method requires the \"Enterprise\" level of the API product.
\n

Lists all suppliers associated with a store queue.

\n
This method requires the \"Enterprise\" level of the API product.
\n

Lists all personnel associated with a store queue.

\n
This method requires the \"Plus\" level of the API product.
\n

Create a remark associated with a defined entity (i.e quote, customer).

Available Paramters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Notes
id	integer	Sequence number of the entity with which to associate the remark
isPublicRemark	bool	Viewing rights for the remark
entityType	string	Available Options: Customer, Header, Quote
remarkType	string	Select from list returned by Get Remark Types endpoint
remark	string	Remark text

\n
This method requires the \"Plus\" level of the API product.
\n

Retrieves a list of all available remark types.

\n
This method requires the \"Enterprise\" level of the API product at a minimum.
\n

Given the lockId returned from the Get Order call, this method will unlock the document. Note that this lockId will be returned on Get Order calls that request a lock only.

Lock ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"2935de13-9e40-4781-a9e1-7f74873af16d"}],"id":"4f817f73-0e98-4ccc-b6af-2110bd4602fe","description":"

\n
The methods in this section require either the \"Plus\" or \"Enterprise\" level of the API product. Check the description for each method to determine the required level. Requests from \"Standard\" API accounts will return Unauthorized.
\n

\n","event":[{"listen":"prerequest","script":{"id":"597e3b9a-c2dd-4939-8bad-da9949d51ff6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7554ec69-cede-41d9-b767-4b28b67c8722","type":"text/javascript","exec":[""]}}],"_postman_id":"4f817f73-0e98-4ccc-b6af-2110bd4602fe","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}}},{"name":"Accounts Payable","item":[{"name":"Record Payables","id":"deba1046-6894-4fe8-89fa-0a5e6477b57f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"supplierName\": \"ACME\",\r\n \"invoiceNumber\": \"XS101\",\r\n \"invoiceDate\": \"9/24/19\",\r\n \"dueDate\": \"10/24/19\",\r\n \"discountableAmount\": 10,\r\n \"nonDiscountableAmount\": 90,\r\n \"discountRate\": 0.1,\r\n \"linkedDocumentNumber\": \"\",\r\n \"internalNotes\": \"Internal note\",\r\n \"remittanceAdviceNotes\": \"Remit note\",\r\n \"detailLines\": [\r\n {\r\n \"storeNumber\": 32,\r\n \"accountCode\": \"101\",\r\n \"subAccountCode\": \"\",\r\n \"amount\": 100,\r\n \"comment\": \"detail line\"\r\n }\r\n ]\r\n }\r\n]"},"url":"https://api.rfms.online/v2/payables","description":"

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Use this method to create one or more payables in RFMS. Call this method with an array of payables. The combination of supplierName and invoiceNumber must be unique for each.

Payable properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Field in RFMS
supplierName	Supplier (who the bill is from)
invoiceNumber	Invoice # (the Supplier's invoice number)
invoiceDate	Invoice Date
dueDate	Due Date
discountableAmount	Discountable
nonDiscountableAmount	Non Discountable
discountRate	Disc Rate
linkedDocumentNumber
internalNotes	A/P Internal Notes
remittanceAdviceNotes	A/P Remittance Advice Notes
detailLines	List of details

Each detail line can have these properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Field in RFMS
storeNumber	Store (note that you must supply the Store number (32), not the Store display code (\" \")
accountCode	Account Code
subAccountCode	Sub Code
amount	Amount
comment	Comment

\n
The methods in this section require the \"Plus\" level of the API product. Requests from \"Standard\" API accounts will return Unauthorized.
\n

\n","event":[{"listen":"prerequest","script":{"id":"b3515688-fbfb-4364-bb84-b592c76ee241","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"07f703d6-f70a-4baa-bc2f-7a90ad12be6d","type":"text/javascript","exec":[""]}}],"_postman_id":"78bc1694-c6d5-4762-9e44-221f39741b13","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}}},{"name":"Schedule Pro","item":[{"name":"Get Job","id":"dbb1f982-5184-4e9c-82aa-9e79bba3be69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rfms.online/v2/job/:id","description":"

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Given a Schedule Pro Job Id, this method fetches the corresponding job.

Gets all scheduled jobs for an order by invoice number.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Invoice number

\n","type":"text/plain"},"type":"any","value":"","key":"number"}]}},"response":[{"id":"f4823991-4bd7-4524-8da5-87ded57b6bf6","name":"Get Scheduled Jobs","originalRequest":{"method":"GET","header":[],"url":"https://api.rfms.online/v2/order/jobs/CG105092"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcTEdpdWxpYW5vXHJlcG9zXG1lYXN1cmVjbG91ZGFwaVxSZm1zUHVibGljQXBpXHYyXG9yZGVyXGpvYnNcQ0cxMDUwOTI=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 18 Nov 2021 14:56:06 GMT"},{"key":"Content-Length","value":"9527"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"OK\",\n \"detail\": [\n {\n \"jobId\": 17458,\n \"jobName\": \"BANUELOS, CARLOS\",\n \"documentNumber\": \"CG105092\",\n \"documentIsClaim\": false,\n \"address\": \"123\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"ZIP\": \"\",\n \"phone1\": \"2059371144\",\n \"phone2\": \"\",\n \"salesperson\": null,\n \"jobStatus\": \"CONTINUED\",\n \"availableStatuses\": null,\n \"crewName\": \"CREW A\",\n \"scheduledStart\": \"20210617\",\n \"scheduledEnd\": \"20210622\",\n \"startTime\": \"08:00:00\",\n \"endTime\": \"17:00:00\",\n \"notes\": \"

\\n

Add a new work order note here as a replacement

\\n

\",\n \"workTicketNotes\": \"

\\n

WORK TICKET NOTE BLAH BLAH BLAH

\\n

\",\n \"certificateOfCompletion\": null,\n \"laborTotal\": 0,\n \"balanceDue\": 0,\n \"storeNumber\": 0,\n \"skipSaturday\": false,\n \"skipSunday\": false,\n \"jobNumber\": null,\n \"jobNumberCaption\": null,\n \"lines\": [\n {\n \"lineId\": 182860,\n \"lineNumber\": 1,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"colorName\": \"AMERICANA\",\n \"quantity\": 20,\n \"units\": \"SF\",\n \"length\": 10,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"11:00:00\",\n \"scheduledEndTime\": \"17:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182861,\n \"lineNumber\": 1,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"colorName\": \"AMERICANA\",\n \"quantity\": 20,\n \"units\": \"SF\",\n \"length\": 10,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"11:00:00\",\n \"scheduledEndTime\": \"17:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182862,\n \"lineNumber\": 1,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"colorName\": \"AMERICANA\",\n \"quantity\": 20,\n \"units\": \"SF\",\n \"length\": 10,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"11:00:00\",\n \"scheduledEndTime\": \"17:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182863,\n \"lineNumber\": 1,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"colorName\": \"AMERICANA\",\n \"quantity\": 20,\n \"units\": \"SF\",\n \"length\": 10,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"11:00:00\",\n \"scheduledEndTime\": \"17:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182864,\n \"lineNumber\": 1,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"colorName\": \"AMERICANA\",\n \"quantity\": 20,\n \"units\": \"SF\",\n \"length\": 10,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"11:00:00\",\n \"scheduledEndTime\": \"17:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182865,\n \"lineNumber\": 1,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"AIMCO LIVING - 12'\",\n \"colorName\": \"AMERICANA\",\n \"quantity\": 20,\n \"units\": \"SF\",\n \"length\": 10,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"11:00:00\",\n \"scheduledEndTime\": \"17:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n }\n ],\n \"attachedFiles\": null\n },\n {\n \"jobId\": 17459,\n \"jobName\": \"BANUELOS, CARLOS\",\n \"documentNumber\": \"CG105092\",\n \"documentIsClaim\": false,\n \"address\": \"123\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"ZIP\": \"\",\n \"phone1\": \"2059371144\",\n \"phone2\": \"\",\n \"salesperson\": null,\n \"jobStatus\": \"CONTINUED\",\n \"availableStatuses\": null,\n \"crewName\": \"CREW B\",\n \"scheduledStart\": \"20210628\",\n \"scheduledEnd\": \"20210701\",\n \"startTime\": \"08:00:00\",\n \"endTime\": \"17:00:00\",\n \"notes\": \"

\\n

Add a new work order note here as a replacement

\\n

\",\n \"workTicketNotes\": \"

\\n

Add a new work ticket note here

\\n

\",\n \"certificateOfCompletion\": null,\n \"laborTotal\": 0,\n \"balanceDue\": 0,\n \"storeNumber\": 0,\n \"skipSaturday\": false,\n \"skipSunday\": false,\n \"jobNumber\": null,\n \"jobNumberCaption\": null,\n \"lines\": [\n {\n \"lineId\": 182866,\n \"lineNumber\": 2,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BAR HARBOR\",\n \"quantity\": 300,\n \"units\": \"SF\",\n \"length\": 100,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"05:00:00\",\n \"scheduledEndTime\": \"14:30:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182867,\n \"lineNumber\": 2,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BAR HARBOR\",\n \"quantity\": 300,\n \"units\": \"SF\",\n \"length\": 100,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"05:00:00\",\n \"scheduledEndTime\": \"14:30:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182868,\n \"lineNumber\": 2,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BAR HARBOR\",\n \"quantity\": 300,\n \"units\": \"SF\",\n \"length\": 100,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"05:00:00\",\n \"scheduledEndTime\": \"14:30:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182869,\n \"lineNumber\": 2,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BAR HARBOR\",\n \"quantity\": 300,\n \"units\": \"SF\",\n \"length\": 100,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"05:00:00\",\n \"scheduledEndTime\": \"14:30:00\",\n \"areas\": null,\n \"attachedFiles\": null\n }\n ],\n \"attachedFiles\": null\n },\n {\n \"jobId\": 17460,\n \"jobName\": \"BANUELOS, CARLOS\",\n \"documentNumber\": \"CG105092\",\n \"documentIsClaim\": false,\n \"address\": \"123\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"ZIP\": \"\",\n \"phone1\": \"2059371144\",\n \"phone2\": \"\",\n \"salesperson\": null,\n \"jobStatus\": \"CONTINUED\",\n \"availableStatuses\": null,\n \"crewName\": \"CREW C\",\n \"scheduledStart\": \"20210704\",\n \"scheduledEnd\": \"20210708\",\n \"startTime\": \"08:00:00\",\n \"endTime\": \"17:00:00\",\n \"notes\": \"

\\n

Add a new work order note here as a replacement

\\n

\",\n \"workTicketNotes\": \"

\\n

Carlos 6/29/2021, 1:33:56 PM

\\n

Work Ticket

\\n

$\\\"\\\"$

\\n

Carlos Banuelos 7/29/2021, 8:16:39 AM

\\n

New Work Ticket Note

\\n

\",\n \"certificateOfCompletion\": null,\n \"laborTotal\": 0,\n \"balanceDue\": 0,\n \"storeNumber\": 0,\n \"skipSaturday\": false,\n \"skipSunday\": false,\n \"jobNumber\": null,\n \"jobNumberCaption\": null,\n \"lines\": [\n {\n \"lineId\": 182870,\n \"lineNumber\": 3,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BUCKSKIN\",\n \"quantity\": 2400,\n \"units\": \"SF\",\n \"length\": 1000,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"07:00:00\",\n \"scheduledEndTime\": \"18:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182871,\n \"lineNumber\": 3,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BUCKSKIN\",\n \"quantity\": 2400,\n \"units\": \"SF\",\n \"length\": 1000,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"07:00:00\",\n \"scheduledEndTime\": \"18:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182872,\n \"lineNumber\": 3,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BUCKSKIN\",\n \"quantity\": 2400,\n \"units\": \"SF\",\n \"length\": 1000,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"07:00:00\",\n \"scheduledEndTime\": \"18:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182873,\n \"lineNumber\": 3,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BUCKSKIN\",\n \"quantity\": 2400,\n \"units\": \"SF\",\n \"length\": 1000,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"07:00:00\",\n \"scheduledEndTime\": \"18:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n },\n {\n \"lineId\": 182874,\n \"lineNumber\": 3,\n \"lineGroup\": 0,\n \"material\": \"CARPET\",\n \"styleName\": \"ALLESANDRO II 30 - 12'\",\n \"colorName\": \"BUCKSKIN\",\n \"quantity\": 2400,\n \"units\": \"SF\",\n \"length\": 1000,\n \"width\": 12,\n \"laborTotal\": 0,\n \"displayColor\": \"FFFF68\",\n \"notesWorkOrder\": null,\n \"notesWorkTicket\": \"\",\n \"rollNumber\": null,\n \"scheduledStartTime\": \"07:00:00\",\n \"scheduledEndTime\": \"18:00:00\",\n \"areas\": null,\n \"attachedFiles\": null\n }\n ],\n \"attachedFiles\": null\n }\n ]\n}"}],"_postman_id":"e20189e6-f551-44c7-9177-3f391805adcd"},{"name":"Get Scheduled Jobs for Crews","id":"44f5dc0b-a7bd-40fe-9665-b00b966cb22a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.rfms.online/v2/jobs/:crew","description":"

Retrieves all scheduled jobs associated with a particular crew, by the name of said crew.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Crew name

\n","type":"text/plain"},"type":"any","value":"","key":"crew"}]}},"response":[{"id":"6b550b1c-afbc-462d-b6fc-7c85ee0b214f","name":"Get Scheduled Jobs for Crews","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rfms.online/v2/jobs/:crew","protocol":"https","host":["api","rfms","online"],"path":["v2","jobs",":crew"],"variable":[{"key":"crew","value":"CREW A"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcTEdpdWxpYW5vXHJlcG9zXG1lYXN1cmVjbG91ZGFwaVxSZm1zUHVibGljQXBpXHYyXGpvYnNcQ1JFVyBB?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 28 Jun 2021 21:52:05 GMT"},{"key":"Content-Length","value":"957"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"OK\",\n \"detail\": [\n {\n \"jobId\": 17455,\n \"jobName\": \"BROWN, CHARLIE\",\n \"documentNumber\": \"CG105053\",\n \"address\": \"1 MAIN ST\",\n \"address2\": \"\",\n \"city\": \"BIRMINGHAM\",\n \"state\": \"AL\",\n \"ZIP\": \"\",\n \"phone1\": \"201-575-0731\",\n \"phone2\": \"\",\n \"salesperson\": null,\n \"jobStatus\": \"GROUT\",\n \"availableStatuses\": null,\n \"crewName\": \"CREW A\",\n \"secondaryCrewName\": \"\",\n \"scheduledStart\": \"20210510\",\n \"scheduledEnd\": \"20210519\",\n \"startTime\": \"08:00:00\",\n \"endTime\": \"17:00:00\",\n \"laborTotal\": 0,\n \"storeNumber\": 0,\n \"skipSaturday\": false,\n \"skipSunday\": false\n },\n {\n \"jobId\": 17458,\n \"jobName\": \"BANUELOS, CARLOS\",\n \"documentNumber\": \"CG105092\",\n \"address\": \"123\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"ZIP\": \"\",\n \"phone1\": \"2059371144\",\n \"phone2\": \"\",\n \"salesperson\": null,\n \"jobStatus\": \"CONTINUED\",\n \"availableStatuses\": null,\n \"crewName\": \"CREW A\",\n \"secondaryCrewName\": \"\",\n \"scheduledStart\": \"20210617\",\n \"scheduledEnd\": \"20210622\",\n \"startTime\": \"08:00:00\",\n \"endTime\": \"17:00:00\",\n \"laborTotal\": 0,\n \"storeNumber\": 0,\n \"skipSaturday\": false,\n \"skipSunday\": false\n }\n ]\n}"}],"_postman_id":"44f5dc0b-a7bd-40fe-9665-b00b966cb22a"},{"name":"Get Jobs For Crew - POST","id":"7d9b8e7c-a918-4670-938f-fd2318a3dc6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"crew\": \"Bed, Bath, & Beyond\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/jobs/crew","description":"

Search for all scheduled jobs associated with a crew name. This method may be used instead of the Get Scheduled Jobs For Crew in all cases, but must be used when the crew name contains special characters, such as the following: & . * ( ) , [ ]

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Returns a list of active job statuses.

\n
Note: In order to successfully update a Schedule Pro job status, the status value must be selected from the list returned by this method.
\n

Updates a job status.

\n
Note: Status must be a selection from the list returned by the Get Active Job Statuses method
\n

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

If there are no work order nor work ticket notes already associated with a scheduled job, the specified notes will be added. Otherwise, the existing notes will be replaced by the new content. When adding notes, specify either one or the other.

\n
This method requires the \"Plus\" level of the API product
\n

Available Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Type	Meaning
id	true	integer	Job ID
workOrderNotes	false	string	Text to add to the work order note field
workTicketNotes	false	string	Text to add to the work ticket note field

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Lists all crews, along with additional information such as availability and naming.

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Query for Schedule Pro jobs based on the following parameters:

Record status date range
Scheduled date range
Job status
State of the Schedule Pro job itself in RFMS (Inserted, Updated, or Both)
Line install date range

For example, a recordStatus value of \"Inserted\" will only return jobs that were inserted within the specified startDate and endDate range. \"Updated\" will return updated only. Finally, a value of \"Both\" will return all jobs both inserted and updated within the given date range.

\n
This method requires the \"Enterprise\" level of the API product at a minimum.
\n

Given both an order document id, and a list of line ids belonging to that order, this method will generate a new, scheduled job based on the content of the order and lines.

\n
This method requires the \"Enterprise\" level of the API product.
\n

Creates a Schedule Pro job.

Handling Validation Errors

When system settings dictate, creating or updating a job may result in validation warnings and restrictions. To override these warnings, do the following:

Take the error list returned in the detail field on the initial call, and for each restriction and/or warning, set the override parameter to true
Assign the list to the jobChecks parameter on the job object.

This will override the validation check warnings and allow the job to be created or updated. See the example \"Create Job - Validation Response\"

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","job"],"host":["api","rfms","online"],"query":[],"variable":[]}},"response":[{"id":"169250fd-552a-41fd-8049-f58304bdfde6","name":"Create Or Update Job","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"jobName\": \"Post Modern Update\",\r\n \"documentNumber\": \"CG203671\",\r\n \"storeNumber\": 32,\r\n \"address\": \"14 Guggenheim Dr\",\r\n \"city\": \"Nowhere\",\r\n \"state\": \"NE\",\r\n \"zip\": \"00331\",\r\n \"crewName\": \"CREW A\",\r\n \"depotName\": \"IN HOUSE\",\r\n \"scheduledStart\": \"2022-04-01\",\r\n \"scheduledEnd\": \"2022-04-02\",\r\n \"customerName\": \"Sol Guggenheim\",\r\n \"notes\": \"Test more notes\",\r\n \"lines\": [\r\n {\r\n \"crewName\": \"Crew A\",\r\n \"material\" : \"Carpet\",\r\n \"productCode\": \"01\",\r\n \"styleName\": \"ABOVE & BEYOND - 13'2\\\"\",\r\n \"colorName\": \"SHINE\",\r\n \"units\": \"SF\",\r\n \"quantity\": 22.0,\r\n \"scheduledDate\": \"2022-04-01\",\r\n \"scheduledStartTime\": \"0008:30:00\",\r\n \"scheduledEndTime\": \"0014:00:00\" \r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:65215/v2/job"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"67"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcTEdpdWxpYW5vXHJlcG9zXG1lYXN1cmVjbG91ZGFwaVxSZm1zUHVibGljQXBpXHYyXGpvYg==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 30 Mar 2022 19:06:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"CG203671\",\n \"detail\": {\n \"docId\": \"17473\"\n }\n}"},{"id":"627e8eb7-013f-4ae9-a75f-36e7d11948ac","name":"Update Job","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"jobId\": 17475,\r\n \"address\": \"15 Guggenheim Dr\",\r\n \"scheduledStart\": \"2022-04-01\",\r\n \"scheduledEnd\": \"2022-04-07\",\r\n \"lines\": [\r\n {\r\n \"lineId\": 183286,\r\n \"scheduledDate\": \"2022-04-07\",\r\n \"scheduledStartTime\": \"0008:30:00\",\r\n \"scheduledEndTime\": \"0014:00:00\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/job"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"67"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcTEdpdWxpYW5vXHJlcG9zXG1lYXN1cmVjbG91ZGFwaVxSZm1zUHVibGljQXBpXHYyXGpvYg==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 05 Apr 2022 13:34:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"CG203671\",\n \"detail\": {\n \"docId\": \"17475\"\n }\n}"},{"id":"aec5c67e-46e4-46cc-b417-e417c37cf3b1","name":"Create Job","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"jobName\": \"Post Modern Designs\",\r\n \"jobNumber\": \"ABC123\",\r\n \"documentNumber\": \"CG203671\",\r\n \"storeNumber\": 32,\r\n \"address\": \"14 Vassar Dr\",\r\n \"address2\": \"Block 40\",\r\n \"city\": \"Somewhere\",\r\n \"state\": \"NE\",\r\n \"zip\": \"00331\",\r\n \"phone1\": \"002-343-2214\",\r\n \"phone2\": \"893-222-2461\",\r\n \"salesperson\": \"Ray Stata\",\r\n \"crewName\": \"CREW A\",\r\n \"secondaryCrew\": \"CREW B\",\r\n \"depotName\": \"IN HOUSE\",\r\n \"scheduledStart\": \"2022-04-05\",\r\n \"scheduledEnd\": \"2022-04-07\",\r\n \"customerName\": \"Frank Gehry\",\r\n \"notes\": \"Test notes\",\r\n \"laborTotal\": \"3421.94\",\r\n \"lines\": [\r\n {\r\n \"crewName\": \"Crew A\",\r\n \"material\" : \"Carpet\",\r\n \"productCode\": \"01\",\r\n \"styleName\": \"ABOVE & BEYOND - 13'2\\\"\",\r\n \"colorName\": \"SHINE\",\r\n \"units\": \"SF\",\r\n \"quantity\": 22.0,\r\n \"scheduledDate\": \"2022-04-05\",\r\n \"scheduledStartTime\": \"0008:30:00\",\r\n \"scheduledEndTime\": \"0014:00:00\" ,\r\n \"notes\": \"line notes\"\r\n }\r\n \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/job"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"67"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcTEdpdWxpYW5vXHJlcG9zXG1lYXN1cmVjbG91ZGFwaVxSZm1zUHVibGljQXBpXHYyXGpvYg==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 05 Apr 2022 13:58:27 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"CG203671\",\n \"detail\": {\n \"docId\": \"17476\"\n }\n}"},{"id":"35eda0d7-3754-4315-b063-976bcda034b8","name":"Create Job - Validation Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"jobName\": \"POST MODERN DESIGNS\",\r\n \"jobNumber\": \"ABC123\",\r\n \"storeNumber\": 32,\r\n //\"documentNumber\": \"CG160623\",\r\n \"address\": \"14 Vassar Dr\",\r\n \"address2\": \"Block 40\",\r\n \"city\": \"Somewhere\",\r\n \"state\": \"NE\",\r\n \"zip\": \"00331\",\r\n \"phone1\": \"002-343-2214\",\r\n \"phone2\": \"893-222-2461\",\r\n \"salesperson\": \"Ray Stata\",\r\n \"crewName\": \"\",\r\n \"secondaryCrew\": \"\",\r\n \"unassigned\": true,\r\n \"depotName\": \"IN HOUSE\",\r\n \"jobStatusId\": 19,\r\n \"timeSlotId\": 5,\r\n \"scheduledStart\": \"2022-12-15\",\r\n \"scheduledEnd\": \"2022-12-20\",\r\n \"customerName\": \"Frank Gehry\",\r\n \"notes\": \"Test notes\",\r\n \"laborTotal\": \"3432\",\r\n \"lines\": [\r\n {\r\n //\"documentNumber\": \"CG160623\",\r\n //\"lineNumber\": 1,\r\n \"crewName\": \"\",\r\n \"material\" : \"Carpet\",\r\n \"productCode\": \"01\",\r\n \"styleName\": \"ABOVE & BEYOND - 13'2\\\"\",\r\n \"colorName\": \"SHINE\",\r\n \"units\": \"SF\",\r\n \"quantity\": 22.0,\r\n \"scheduledDate\": \"2022-12-15\",\r\n \"scheduledStartTime\": \"0008:30:00\",\r\n \"scheduledEndTime\": \"0018:00:00\" \r\n }\r\n \r\n ],\r\n \"jobChecks\": [\r\n {\r\n \"jobCheckType\": \"Track1NoSelection\",\r\n \"restrictLevel\": \"Warning\",\r\n \"message\": \"NO SELECTION HAS BEEN MADE FOR SERVICE REASON\",\r\n \"override\": true\r\n },\r\n {\r\n \"jobCheckType\": \"Track2NoSelection\",\r\n \"restrictLevel\": \"Warning\",\r\n \"message\": \"NO SELECTION HAS BEEN MADE FOR ALTERNATE LIST\",\r\n \"override\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/job"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"332"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcTEdpdWxpYW5vXHJlcG9zXG1lYXN1cmVjbG91ZGFwaVxSZm1zUHVibGljQXBpXHYyXGpvYg==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 07 Dec 2022 21:41:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"result\": \"Error saving job\",\n \"detail\": [\n {\n \"JobCheckType\": \"Track1NoSelection\",\n \"RestrictLevel\": \"Warning\",\n \"Message\": \"NO SELECTION HAS BEEN MADE FOR SERVICE REASON\",\n \"Override\": null\n },\n {\n \"JobCheckType\": \"Track2NoSelection\",\n \"RestrictLevel\": \"Warning\",\n \"Message\": \"NO SELECTION HAS BEEN MADE FOR ALTERNATE LIST\",\n \"Override\": null\n }\n ]\n}"}],"_postman_id":"826e3dba-7892-42ec-938c-1a08f7b54f20"},{"name":"Update Job","id":"eea667bc-096f-47dc-b462-7f2be4d9bb73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"jobId\": 17475,\r\n \"unassigned\": false,\r\n \"lines\": [\r\n {\r\n \"lineId\": 183286,\r\n \"documentNumber\": \"CG203671\",\r\n \"lineNumber\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rfms.online/v2/job","description":"

\n
This method requires the \"Enterprise\" level of the API product.
\n

Update a job with a given id.

Updating lines

\"Enterprise\" level API users can also add, delete, and edit lines. Here are some examples:

To delete a line, include just the line id and delete: true.

Handling Validation Errors

See Create Job documentation for more details.

{\n    \"jobId\": 1234,\n    \"lines\": [ { \"lineId\": 215541, \"delete\": true } ]\n}\n\n

To edit a line, include the line id:

{\n    \"jobId\": 1235,\n    \"lines\": [ { \"lineId\": 215541, \"scheduledStartTime\":\"0008:30\", \"scheduledEndTime\": \"0012:00\", \"quantity\": 100, \"deductCapacity\": true } ]\n}\n\n

To add a new line, omit line id:

{\n    \"jobId\": 1235,\n    \"lines\":[ { \"scheduledStartTime\":\"0008:30\", \"scheduledEndTime\": \"0012:00\", \"quantity\": 100, \"material\": \"CARPET\", \"deductCapacity\": true } ]\n}\n\n

When modifying or adding lines, the following elements are supported:

material
quantity
productCode
scheduledDate
styleName
colorName
units
scheduledStartTime
scheduledEndTime
documentNumber
lineNumber (on associated order - if provided)
crewName
deductCapacity
depotName

\n
This method requires the \"Enterprise\" level of the API product.
\n

Given a jobId and a jobLineId, generate a provider record. The job line must already have a document number and a line number associated with it for the call to be successful.

\n
This method requires the \"Plus\" level of the API product.
\n

Lists all available time slots that a job can have.

\n
This method requires the \"Plus\" level of the API product.
\n

Lists all available track listing descriptions for a job. The \"track1Listings\" result contains a set of descriptions that can only be used for setting the matching \"track1Description\" field on a job. Likewise, the \"track2Listings\" result set can only be used for setting \"track2Description\" field.

\n
This method requires the \"Plus\" level of the API product.
\n

Lists all available job statuses that a job can have

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Gets a list of job types.

Provided an order number, this request will return the quote or estimate used to create given order.

\n
Requires API product level of Plus or higher
\n

If the detail field returns as null, then the specified order has no quote or estimate origins.

Order number for which to retrieve origin quote or estimate

\n","type":"text/plain"},"type":"string","value":"","key":"number"}]}},"response":[{"id":"582300d2-1d32-45be-83ae-ac24289d2fdf","name":"Get Order History","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rfms.online/v2/order/history/:number","protocol":"https","host":["api","rfms","online"],"path":["v2","order","history",":number"],"variable":[{"key":"number","value":"CG003632"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"170"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 06 Jul 2020 23:16:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": \"OK\",\n \"detail\": \"JE100250.1\"\n}"}],"_postman_id":"82837eef-64a3-451c-9097-be13da4b898f"}],"id":"8e39569e-5685-4386-bac7-ee97acfb08f4","_postman_id":"8e39569e-5685-4386-bac7-ee97acfb08f4","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":true,"source":{"_postman_id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","id":"e78eadda-8135-40e5-8fa3-e24bfc70c0f8","name":"RFMS API 2","type":"collection"}}},{"name":"Reports","item":[{"name":"Generate Report","id":"f7837f1c-23b4-4d23-a937-37ce88c94860","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"documentNumber\": \"ES103271\",\r\n \"options\": {\r\n \"showLogo\": true,\r\n \"storeAddress\": true,\r\n \"storeName\": true,\r\n \"showRoomPlan\": true,\r\n \"showSeams\": true,\r\n \"showGrandTotal\": true,\r\n \"showColorChip\": true,\r\n \"showQuantity\": true,\r\n \"showUnitPrice\": true, \r\n \"showLineTotal\": true, \r\n \"showApprove\": true,\r\n \"showDeliveryDate\": true,\r\n \"showPhotos\": true,\r\n \"showLineNotes\": true, \r\n \"showLineGroups\": true, \r\n \"showPayment\": true, \r\n \"showSignature\": true,\r\n \"showAuthorization\": true, \r\n \"allowAuthorization\": true,\r\n \"allowPayment\": false,\r\n \"termsToShow\": [\"Terms and Conditions\", \"Bullet Point Terms\"],\r\n \"defaultShareMessage\": \"Here are some options\" \r\n }\r\n}"},"url":"https://api.rfms.online/v2/quote/report/generate","description":"

\n
This method requires the \"Plus\" level of the API product.
\n

Given a quote number and a series of options, this method will return a MyFlooringLink URL to the newly generated report. The options below are all the available ones to choose from when determining which fields will be displayed on the report. All listed options are optional and, if not included, will simply default to a false value.

To customize which terms and conditions are listed on the report, use the Get Terms endpoint to view a list of terms titles. Then, include the termsToShow parameter, followed by an array of chosen terms titles.

\n
Note: To generate a report for an order, simply use an order number and call the endpoint like so: v2/order/report/generate
\n

\n
This method requires the \"Plus\" level of the API product at a minimum.
\n

Gets a list of all terms and conditions maintained by a company. All terms and conditions means the default terms, as well as terms for a specific store. Only stores that have terms and conditions saved will appear in the returned result. Other stores ought to use the terms belonging to the default option.

To get terms and conditions belonging to a secondary company, use the following request:

GET /v2/report/terms/{companyId}

Sync all store setttings.

\n
Note: This method is very taxing on the server and should be used sparingly and with intent.
\n

This method allows for making raw data queries directly to RFMS.

The format of the query is as follows:

{\n   \"methodName\": \"RfmsMethod\",\n   \"requestPayload\": {\n      //data query here\n   }\n}\n\n