{
"opencollection": "1.0.0",
"info": {
"name": "Broadlume BMS API",
"version": "v1"
},
"request": {
"auth": {
"type": "apikey",
"key": "x-api-key",
"value": "{{x-api-key}}",
"placement": "header"
}
},
"items": [
{
"info": {
"name": "Version",
"type": "folder"
},
"items": [
{
"info": {
"name": "API Version",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/version",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
]
},
"docs": "API version"
}
]
},
{
"info": {
"name": "Authentication",
"type": "folder"
},
"items": [
{
"info": {
"name": "Session Keepalive",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/token",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
]
},
"docs": "Sessions expire based on a server specified timeout period. Use this endpoint to verify that a token is still valid and to reset the last active time of a call."
},
{
"info": {
"name": "Authenticate User / Create Session",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/token",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Authenticate the user with the system and obtain the token. Token is used for all subsequent API calls. Sessions will expire based on a server specified timeout period. In order to use a session for long term use the token(keepalive) endpoint to keep the session token active. All calls will update and refresh the last active time of a token, so a keepalive call is only necessary when idle. Idle time is a default of 5 minutes."
},
{
"info": {
"name": "Remove Session",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/token",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sessions expire based on a server specified timeout period. Use this endpoint to verify that a token is still valid and to reset the last active time of a call. In order to get a new application token, a DELETE token endpoint must be called to reset the key that is issued."
},
{
"info": {
"name": "Session Count",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/sessioncount",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
]
},
"docs": "Currently active session count and limit"
},
{
"info": {
"name": "User permissions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/permissions",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "User web permissions"
},
{
"info": {
"name": "Change Branches",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/changebranch",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Change currently active branches"
}
]
},
{
"info": {
"name": "Order",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Order",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/order",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
}
]
},
"docs": "Get order header information"
},
{
"info": {
"name": "Create Order",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/order",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates an order. Returns the successfully created order."
},
{
"info": {
"name": "Update Order",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/order",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "custpo",
"value": "",
"type": "query",
"description": "Required when customer ship to requires and not already filled for existing ship to code."
},
{
"name": "ordcustid",
"value": "",
"type": "query"
},
{
"name": "ordsalesrep1",
"value": "",
"type": "query",
"description": "Required when not already filled ship to requires and not already filled for existing ship to code. Assumes user salesperson initials if not sent and if user is salesperson."
},
{
"name": "ordsalesrep2",
"value": "",
"type": "query"
},
{
"name": "ordjobtype",
"value": "",
"type": "query",
"description": "Required when not already filled."
},
{
"name": "ordstatuscode",
"value": "",
"type": "query",
"description": "Required when not already filled."
},
{
"name": "shcode",
"value": "",
"type": "query",
"description": "Ship to code of 0000 is assumed when not sent and info has not been filled or when changing customer."
},
{
"name": "shname",
"value": "",
"type": "query",
"description": "Ship to information is assumed when changing ship to code or customer and info has not been sent."
},
{
"name": "shaddr1",
"value": "",
"type": "query",
"description": "Ship to information is assumed when changing ship to code or customer and info has not been sent."
},
{
"name": "shaddr2",
"value": "",
"type": "query",
"description": "Ship to information is assumed when changing ship to code or customer and info has not been sent."
},
{
"name": "shctyst",
"value": "",
"type": "query",
"description": "Ship to information is assumed when changing ship to code or customer and info has not been sent."
},
{
"name": "shcity",
"value": "",
"type": "query",
"description": "Ship to information is assumed when changing ship to code or customer and info has not been sent."
},
{
"name": "shstate",
"value": "",
"type": "query",
"description": "Ship to information is assumed when changing ship to code or customer and info has not been sent."
},
{
"name": "shzip",
"value": "",
"type": "query",
"description": "Ship to information is assumed when changing ship to code or customer and info has not been sent."
},
{
"name": "shbuilding",
"value": "",
"type": "query",
"description": "When used, will override first section of shaddr2 field"
},
{
"name": "shunit",
"value": "",
"type": "query",
"description": "When used, will override last section of shaddr2 field"
},
{
"name": "insdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Changes the single install date for a job (does not function with multi-date records) or when capacities are turned on."
},
{
"name": "time",
"value": "",
"type": "query",
"description": "Changes the install time for a job (does not function with multi-date records) or when capacities are turned on."
},
{
"name": "initials",
"value": "",
"type": "query",
"description": "Required when company control is turned on and install date is sent."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing order. Returns the key (header info) of the order updated. Only fields sent will update."
},
{
"info": {
"name": "Update Order Line Installer (Single Date Only)",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/orderlineinstaller",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
},
{
"name": "installer",
"value": "",
"type": "query"
},
{
"name": "taxable",
"value": "",
"type": "query",
"description": "Y or N"
}
]
},
"docs": "Sets/updates the installer for a single labor line
Single Intall Date Only "
},
{
"info": {
"name": "Get Order Lines - Inactive until 2102 Release",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/orderline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Required When Audit Date Is Not Sent."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Job Status."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks at Job Audit Date in Range."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - - Looks at Job Audit Date in Range."
}
]
},
"docs": "Get Order Lines - Inactive until 2102 Release"
},
{
"info": {
"name": "Create Order Line",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/orderline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a line on an existing order. Returns the key (header info) of the order updated.
Only one of these parameters (ordlseq, ordlb2bsku, ordlbarcode) is required. If more than one is passed they execute in the precedence of ordlseq > ordlb2bsku > ordlbarcode"
},
{
"info": {
"name": "Sales Reps",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/salesreps",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Sales Rep list"
},
{
"info": {
"name": "Order Type List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/ordertype",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Order Type list"
},
{
"info": {
"name": "Accumulator Code List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/accumcode",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Accumulator Code List"
},
{
"info": {
"name": "Order Time Slot List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/ordertimeslots",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Order Time Slot List"
},
{
"info": {
"name": "Orders by date range",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/orders",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "custid",
"value": "",
"type": "query"
},
{
"name": "ordstatus",
"value": "",
"type": "query",
"description": "Appending and using I returns closed orders, using A returns open and closed orders."
},
{
"name": "shaddr1",
"value": "",
"type": "query",
"description": "Searches shipto address 1 and 2, used only when startswith is not sent."
},
{
"name": "startswith",
"value": "",
"type": "query",
"description": "Searches shipto address 1 and 2, used only when shaddr1 is not sent."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD, required when searching with shaddr1, or when startswith is not sent."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD, required when searching with shaddr1, or when startswith is not sent."
}
]
},
"docs": "Orders by date range"
},
{
"info": {
"name": "Aging Invoices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/invoicedue",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "days",
"value": "",
"type": "query",
"description": "Days Old"
}
]
},
"docs": "Aging Invoices"
},
{
"info": {
"name": "Get order line commments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/linecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Get all order line commments"
},
{
"info": {
"name": "Create Order Line Comment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/linecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates an order line comment."
},
{
"info": {
"name": "Update Order Line Comment",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/linecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
},
{
"name": "commseq",
"value": "",
"type": "query"
},
{
"name": "linenote",
"value": "",
"type": "query"
}
]
},
"docs": "Updates an existing order line comment."
},
{
"info": {
"name": "Delete order line commment",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/linecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
},
{
"name": "commseq",
"value": "",
"type": "query"
}
]
},
"docs": "Delete order line comment"
},
{
"info": {
"name": "Reads a Job Note",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/jobnote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "jobpage",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Reads a Job Note"
},
{
"info": {
"name": "Creates a Job Note",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/jobnote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Job Note"
},
{
"info": {
"name": "Edits a Job Note",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/jobnote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "note",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Edits a Job Note"
},
{
"info": {
"name": "Erases a Job Note",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/jobnote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Erases a Job Note"
},
{
"info": {
"name": "List of Initials",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/initials",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query"
}
]
},
"docs": "List of Initials"
},
{
"info": {
"name": "Job Status List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/jobstats",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "jobstat",
"value": "",
"type": "query"
},
{
"name": "jstattype",
"value": "",
"type": "query",
"description": "Job Status types - order, quote, lead, spaces returns all"
}
]
},
"docs": "Job Status List"
},
{
"info": {
"name": "Get Region Tax Codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/regiontax",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "region",
"value": "",
"type": "query",
"description": "Optional - use to return tax details for a single region"
}
]
},
"docs": "Get Region tax codes by company and/or region"
},
{
"info": {
"name": "Get Sales Rep Commission Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/commissiondetails",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch specific commission info when applicable."
},
{
"name": "salesid",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Get Sales Rep Commission Details"
},
{
"info": {
"name": "Tax Code Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/taxcode",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "taxcode",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Last Edit Date - Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Last Edit Date - Format - YYYYMMDD"
},
{
"name": "alphanumericstart",
"value": "",
"type": "query"
},
{
"name": "alphanumericend",
"value": "",
"type": "query"
}
]
},
"docs": "Get tax code details by company"
},
{
"info": {
"name": "Get ORDLSUB Records",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/orderlinesub",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "jobstatus",
"value": "",
"type": "query",
"description": "Optional, open/closed. When not sent open and closed jobs are returned."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "job",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Get ORDLSUB Records"
}
]
},
{
"info": {
"name": "Customer",
"type": "folder"
},
"items": [
{
"info": {
"name": "Customer List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customers",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks for Last Invoice date, Last Pay date, or Last Edit date in range. If no date range is sent, a full list of customers will be returned."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks for Last Invoice date, Last Pay date, or Last Edit date in range. If no date range is sent, a full list of customers will be returned."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Sending a type Value of 'PC' along with a product code will return customers who have purchased that product in the date range. A value of 'EDIT' and passing 'startdate' and 'enddate' or 'lastdays' will return only customer records that have been edited within that timeframe."
},
{
"name": "prodcode",
"value": "",
"type": "query",
"description": "Sending a type Value of PC along with a product code will return customers who have purchased that product in the date range."
},
{
"name": "startdate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks customer creation date."
},
{
"name": "enddate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks customer creation date."
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
},
{
"name": "salesid",
"value": "",
"type": "query"
},
{
"name": "salesid2",
"value": "",
"type": "query"
}
]
},
"docs": "Get all current customers. Can be used to find customers with last invoice date within date range, last pay date in date range, or last edited date of customer record."
},
{
"info": {
"name": "Customer info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customer",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query",
"description": "(required if customername is not passed) References the customer id field. Leading spaces need to be filled with websafe spacing."
},
{
"name": "customername",
"value": "",
"type": "query",
"description": "(required if customer is not passed) References the customer name. Spaces need to be filled with websafe spacing."
}
]
},
"docs": "Get customer info. Either customer or customername are required."
},
{
"info": {
"name": "Customer info",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/customer",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create customer."
},
{
"info": {
"name": "Customer info",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/customer",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update customer."
},
{
"info": {
"name": "Customer Search",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customersearchbyphone",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "term",
"value": "",
"type": "query",
"description": "Search term for phone number"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Customer Search"
},
{
"info": {
"name": "Customer Search",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customersearch",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Last edited date."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Last edited date."
},
{
"name": "term",
"value": "",
"type": "query",
"description": "Search term"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Customer Search"
},
{
"info": {
"name": "Customer Properties",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customerproperties",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query",
"description": "Customer ID"
}
]
},
"docs": "Customer Properties"
},
{
"info": {
"name": "Customer Property Managers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customerpropertymanagers",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Customer Property Managers"
},
{
"info": {
"name": "Customer Invoices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customerinvoices",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "DEP, ORD, INV, IVA (Returns all invoices within date range, does not use customer ID)"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Optional - \"I\" searches by invoice date, otherwise register date is used."
}
]
},
"docs": "Customer Invoices List"
},
{
"info": {
"name": "Customer 5 Year Sales",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customer5year",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "role",
"value": "",
"type": "query",
"description": "Sending S totals sales, R totals open invoice items"
}
]
},
"docs": "Customer 5 Year Sales"
},
{
"info": {
"name": "Customer AR Contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customerARcontacts",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Customer AR Contacts"
},
{
"info": {
"name": "Creates Customer Contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/customercontact",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates Customer Contact"
},
{
"info": {
"name": "Updates Existing Customer Contact",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/customercontact",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "contact",
"value": "",
"type": "query",
"description": "Contact Key"
},
{
"name": "sequence",
"value": "",
"type": "query",
"description": "AR contact sequence number"
},
{
"name": "firstname",
"value": "",
"type": "query",
"description": "Contact First Name"
},
{
"name": "lastname",
"value": "",
"type": "query",
"description": "Contact Last Name"
},
{
"name": "contactrole",
"value": "",
"type": "query",
"description": "Contact Role"
},
{
"name": "phone1",
"value": "",
"type": "query",
"description": "Contact Phone"
},
{
"name": "phone2",
"value": "",
"type": "query",
"description": "Contact Cell Phone"
},
{
"name": "email",
"value": "",
"type": "query",
"description": "Contact Email"
},
{
"name": "text2",
"value": "",
"type": "query",
"description": "Contact Can Be Texted - Format - 1 For Y, 0 For N."
}
]
},
"docs": "Update Existing Customer Contact"
},
{
"info": {
"name": "Customer AR Contact Notes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customerARnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "contact",
"value": "",
"type": "query"
},
{
"name": "seq",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Customer AR Contact Notes"
},
{
"info": {
"name": "Create Customer AR Contact Notes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/ customerARnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Customer AR Contact Notes"
},
{
"info": {
"name": "Update Customer AR Contact Notes",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/ customerARnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Customer AR Contact Notes"
},
{
"info": {
"name": "All Customer Contact Notes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/ ContactNotesbyID",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "All Customer Contact Notes"
},
{
"info": {
"name": "Customer Sales",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customersaleslist",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Customer Sales List"
},
{
"info": {
"name": "Get Contact Role List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/roleList",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get Contact Role List"
},
{
"info": {
"name": "Ship To Information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/shipto",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Required to return valid sale rep contact information."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "shipto",
"value": "",
"type": "query"
}
]
},
"docs": "Return Ship To Contact Information"
},
{
"info": {
"name": "Customer Ship To Codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customershiptos",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "custid",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Gets all customer ship to codes"
},
{
"info": {
"name": "Payment History",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/payhist",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query"
},
{
"name": "enddate",
"value": "",
"type": "query"
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Payment History"
},
{
"info": {
"name": "AR Open Items",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/aropenitem",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query"
},
{
"name": "enddate",
"value": "",
"type": "query"
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "AR Open Items"
},
{
"info": {
"name": "Ship To Code List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/shiptocodes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "When not used, sales rep emails cannot be returned"
},
{
"name": "customer",
"value": "",
"type": "query",
"description": "When not used, all customers are returned"
}
]
},
"docs": "Ship To Code List"
},
{
"info": {
"name": "Get list of national property manager relationships",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/nationalpropertymanagers",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get list of national property manager relationships"
},
{
"info": {
"name": "Reads a Customer Note",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customernotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Reads a Customer Note"
},
{
"info": {
"name": "Creates a Customer Note",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/customernotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Customer Note"
},
{
"info": {
"name": "Edits a Customer Note",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/customernotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "note",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Edits a Customer Note"
},
{
"info": {
"name": "Erases a Customer Note",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/customernotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Erases a Customer Note"
},
{
"info": {
"name": "Reads a Sales Note",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/salesnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Reads a Sales Note"
},
{
"info": {
"name": "Creates a Sales Note",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/salesnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Sales Note"
},
{
"info": {
"name": "Edits a Sales Note",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/salesnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "custnote",
"value": "",
"type": "query"
}
]
},
"docs": "Edits a Sales Note"
},
{
"info": {
"name": "Erases a Sales Note",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/salesnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Erases a Sales Note"
},
{
"info": {
"name": "Gets all Customer Note by ShipTo Code - Inactive until 2102 Release",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/shiptonotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Gets all Customer Note by ShipTo Code - Inactive until 2102 Release"
},
{
"info": {
"name": "Creates a Customer Note by ShipTo Code - Inactive until 2102 Release",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/shiptonotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Customer Note by ShipTo Code - Inactive until 2102 Release"
},
{
"info": {
"name": "Updates a Customer Note by ShipTo Code - Inactive until 2102 Release",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/shiptonotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "note",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a Customer Note by ShipTo Code - Inactive until 2102 Release"
},
{
"info": {
"name": "Erases a Customer Note by ShipTo Code - Inactive until 2102 Release",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/shiptonotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Erases a ShipTo Note - Inactive until 2102 Release"
},
{
"info": {
"name": "Customer Search",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customersearchbyemail",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "terms",
"value": "",
"type": "query",
"description": "Search term for email address"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Customer Search"
},
{
"info": {
"name": "Get List of possible customer credit status codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customercreditstats",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get List of possible customer credit status codes"
}
]
},
{
"info": {
"name": "Company",
"type": "folder"
},
"items": [
{
"info": {
"name": "Company Info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/company",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get company info"
},
{
"info": {
"name": "Branch info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/branch",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
}
]
},
"docs": "Get branch info"
},
{
"info": {
"name": "Branches list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/branches",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get branches info"
},
{
"info": {
"name": "System Information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/systeminfo",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
]
},
"docs": "Return various configuration, system, company, and branch settings"
},
{
"info": {
"name": "Global settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/globalsettings",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
]
},
"docs": "Settings list"
},
{
"info": {
"name": "Settings specific to a company",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/companysettings",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Settings list for specific company objects"
},
{
"info": {
"name": "Territory Codes List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/territorycodes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Territory Codes List"
}
]
},
{
"info": {
"name": "Product",
"type": "folder"
},
"items": [
{
"info": {
"name": "Product types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/producttypes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Product types list"
},
{
"info": {
"name": "Product codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/productcodes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodtype",
"value": "",
"type": "query"
}
]
},
"docs": "Product codes list"
},
{
"info": {
"name": "Product styles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/productstyles",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodcode",
"value": "",
"type": "query"
},
{
"name": "prodtype",
"value": "",
"type": "query",
"description": "Optional product type to narrow results"
}
]
},
"docs": "Product styles list"
},
{
"info": {
"name": "Product styles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/productstylessearch",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "catstatus",
"value": "",
"type": "query",
"description": "Optional status to narrow results - can be Y or N."
},
{
"name": "prodcode",
"value": "",
"type": "query",
"description": "Optional product code to narrow results"
},
{
"name": "prodtype",
"value": "",
"type": "query",
"description": "Optional product type to narrow results"
},
{
"name": "term",
"value": "",
"type": "query",
"description": "Used to match possibly styles. Partial text search in all characters of style field used. The more precise the name is, the quicker the return will usually complete. Searching wildcard or low character count terms can take longer."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Product styles list"
},
{
"info": {
"name": "Product colors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/productcolors",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodcode",
"value": "",
"type": "query"
},
{
"name": "prodstyle",
"value": "",
"type": "query",
"description": "Used to match possibly styles. Partial text search in all characters of style field used. The more precise the name is, the quicker the return will usually complete. Searching wildcard or low character count terms can take longer."
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Catseq is not required .If all fields provided, only catseq is used."
}
]
},
"docs": "Product colors list"
},
{
"info": {
"name": "Product stock",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/productstock",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query",
"description": "Barcode or Catseq required."
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Barcode or Catseq required."
}
]
},
"docs": "Product stock list"
},
{
"info": {
"name": "Product price",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/productprice",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch specific pricing when applicable."
},
{
"name": "barcode",
"value": "",
"type": "query"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Barcode or Catseq required to return stock. If both are provided, only catseq is used."
},
{
"name": "customer",
"value": "",
"type": "query",
"description": "Optional, gets customer/property mgr specific special pricing when applicable."
},
{
"name": "customertype",
"value": "",
"type": "query",
"description": "Optional, gets customer type specific special pricing when applicable."
},
{
"name": "shipto",
"value": "",
"type": "query",
"description": "Optional, gets property mgr specific special pricing when applicable, customer is required when using shipto."
}
]
},
"docs": "Product price"
},
{
"info": {
"name": "Product Attributes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/catalogattributes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "catseq",
"value": "",
"type": "query"
}
]
},
"docs": "Product Attributes for Catalog Sequence"
},
{
"info": {
"name": "Attributes Labels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/attributelabels",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodtype",
"value": "",
"type": "query"
}
]
},
"docs": "Attributes Labels"
},
{
"info": {
"name": "Web Products",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/webproducts",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
},
{
"name": "role",
"value": "",
"type": "query",
"description": "1 returns active web products"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks for last catalog record update date."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks for last catalog record update date."
}
]
},
"docs": "Web Products"
},
{
"info": {
"name": "Product details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/catalogdetails",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Barcode or Catseq required."
}
]
},
"docs": "Product details"
},
{
"info": {
"name": "Get Associated Products",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/associatedproducts",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "catseq",
"value": "",
"type": "query"
}
]
},
"docs": "Associated Products List"
},
{
"info": {
"name": "Catalog Items",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/catalogitems",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Optional - Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
}
]
},
"docs": "Gets all catalog items"
},
{
"info": {
"name": "Get Catalog Attribute Collections",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrcollection",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodtype",
"value": "",
"type": "query",
"description": "Optional - returns collection by product type"
}
]
},
"docs": "Get Catalog Attribute Collections"
},
{
"info": {
"name": "Get Catalog Attribute Brands",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrbrands",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodtype",
"value": "",
"type": "query",
"description": "Optional - returns brands by product type"
}
]
},
"docs": "Get Catalog Attribute Brands"
},
{
"info": {
"name": "Get Catalog Attribute Sales Rep",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrsalesrep",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch-specific info when applicable"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Catalog Attribute Sales Rep"
},
{
"info": {
"name": "Get Catalog Attribute Inventory Types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrinventory",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch-specific info when applicable"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Catalog Attribute Inventory Types"
},
{
"info": {
"name": "Get Catalog Attribute Customer",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrcustomer",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch-specific info when applicable"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Catalog Attribute Customers"
},
{
"info": {
"name": "Get Catalog Attribute Dates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrdate",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch-specific info when applicable"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Catalog Attribute Dates"
},
{
"info": {
"name": "Get Selected Inventory Catalog Attribute",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrselinv",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodtype",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Selected Inventory Catalog Attribute"
},
{
"info": {
"name": "Get Selected Catalog Attribute File 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrsel2",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodtype",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Selected Catalog Attribute File 2"
},
{
"info": {
"name": "Get Selected Catalog Attribute File 3",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getcatatrsel3",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "prodtype",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Selected Catalog Attribute File 3"
}
]
},
{
"info": {
"name": "Retail Pricing",
"type": "folder"
},
"items": [
{
"info": {
"name": "Sample Pricing Data",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/productpagedetails",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Catalog ID for product"
}
]
},
"docs": "Grabs necessary data from QR code for sample pricing fields"
}
]
},
{
"info": {
"name": "Edocs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Edocs List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/edocs",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "edoctype",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "required when edoctype is 'order'"
},
{
"name": "leadno",
"value": "",
"type": "query",
"description": "required when edoctype is 'lead'"
},
{
"name": "po",
"value": "",
"type": "query",
"description": "required when edoctype is 'po'"
},
{
"name": "quote",
"value": "",
"type": "query",
"description": "required when edoctype is 'quote'"
},
{
"name": "customer",
"value": "",
"type": "query",
"description": "required when edoctype is 'property' or 'customer'"
},
{
"name": "shcode",
"value": "",
"type": "query",
"description": "required when edoctype is 'property'"
},
{
"name": "property",
"value": "",
"type": "query",
"description": "required when edoctype = 'property'"
},
{
"name": "vendor",
"value": "",
"type": "query",
"description": "required when edoctype is 'vendor' or 'apinvoice'"
},
{
"name": "refnum",
"value": "",
"type": "query",
"description": "required when edoctype is 'apinvoice'"
},
{
"name": "aptype",
"value": "",
"type": "query",
"description": "required when edoctype is 'apinvoice'"
}
]
},
"docs": "Get edocs for object record"
},
{
"info": {
"name": "Edoc download",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/edoc",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "edoctype",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "required when edoctype is 'order'"
},
{
"name": "leadno",
"value": "",
"type": "query",
"description": "required when edoctype is 'lead'"
},
{
"name": "po",
"value": "",
"type": "query",
"description": "required when edoctype is 'po'"
},
{
"name": "quote",
"value": "",
"type": "query",
"description": "required when edoctype is 'quote'"
},
{
"name": "seq",
"value": "",
"type": "query"
},
{
"name": "customer",
"value": "",
"type": "query",
"description": "required when edoctype is 'property' or 'customer'"
},
{
"name": "shcode",
"value": "",
"type": "query",
"description": "required when edoctype is 'property'"
},
{
"name": "property",
"value": "",
"type": "query",
"description": "required when edoctype = 'property'"
},
{
"name": "vendor",
"value": "",
"type": "query",
"description": "required when edoctype is 'vendor' or 'apinvoice'"
},
{
"name": "refnum",
"value": "",
"type": "query",
"description": "required when edoctype is 'apinvoice'"
},
{
"name": "aptype",
"value": "",
"type": "query",
"description": "required when edoctype is 'apinvoice'"
}
]
},
"docs": "Get edoc download"
},
{
"info": {
"name": "Edoc upload",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/edoc",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upload edoc"
},
{
"info": {
"name": "Get Edoc types for user",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/edoctypes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
}
]
},
"docs": "Get Edoc types for user"
}
]
},
{
"info": {
"name": "Install",
"type": "folder"
},
"items": [
{
"info": {
"name": "Installers list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installers",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
}
]
},
"docs": "Installers list"
},
{
"info": {
"name": "Installer info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installer",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "installer",
"value": "",
"type": "query"
}
]
},
"docs": "Installer info"
},
{
"info": {
"name": "Installer List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installerlist",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Installer List"
},
{
"info": {
"name": "Install List by date",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installdetail",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "job",
"value": "",
"type": "query",
"description": "Job (order) number"
},
{
"name": "lnnum",
"value": "",
"type": "query",
"description": "Line number. Send as 'X' if returning multi-date records."
},
{
"name": "instime",
"value": "",
"type": "query",
"description": "Install time code. Send as 'X' if returning multi-date records."
},
{
"name": "insdate",
"value": "",
"type": "query",
"description": "Install date. Send as 'X' if returning multi-date records."
},
{
"name": "insseq",
"value": "",
"type": "query",
"description": "Install line sequence. Send as 'X' if returning multi-date records."
},
{
"name": "installer",
"value": "",
"type": "query",
"description": "Installer ID. Send as 'X' if returning multi-date records."
}
]
},
"docs": "Order Time Slot List"
},
{
"info": {
"name": "Generate Installer Invoice PDF",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installerinvoice",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query",
"description": "Job (order) number"
},
{
"name": "gst",
"value": "",
"type": "query",
"description": "GST input, expecting .99 format (percentile)"
},
{
"name": "invoicenumber",
"value": "",
"type": "query"
},
{
"name": "invoicehours",
"value": "",
"type": "query",
"description": "Format of 999.999 expected"
},
{
"name": "note",
"value": "",
"type": "query"
}
]
},
"docs": "Generate Installer Invoice PDF"
},
{
"info": {
"name": "Installations By Date",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getinstallations",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "beginning",
"value": "",
"type": "query",
"description": "Sending 1 will search for install date records that have an earliest job starting date in range. Sending 2 will search for install date records that have an earliest accum starting date in range."
},
{
"name": "leadslsfilter",
"value": "",
"type": "query",
"description": "CSV list of salesperson IDs. Special item `*!*` can be passed to denote empty or null sales ID's on an install. Should be urlencoded. See [salesreps](#/Order/get_salesreps) endpoint for more info."
},
{
"name": "leadjsfilter",
"value": "",
"type": "query",
"description": "CSV list of order statuses. Special item `*!*` can be passed to denote empty or null job status. Should be urlencoded. See [orderstatus](#/Order/get_orderstatus) endpoint for more info."
},
{
"name": "accumcodesfilter",
"value": "",
"type": "query",
"description": "CSV list of accum codes. See [accumcode](#/Order/get_accumcode) endpoint for more info."
},
{
"name": "installers",
"value": "",
"type": "query",
"description": "CSV list of installers. Special item `*!*` can be passed to denote empty or null installer on an install. Should be urlencoded. See [installerlist](#/Install/get_installerlist) endpoint for more info."
},
{
"name": "jobtypes",
"value": "",
"type": "query",
"description": "CSV list of job types. Special item `*!*` can be passed to denote empty or null job type on an install. Should be urlencoded. See [ordertype](#/Order/get_ordertype) endpoint for more info."
},
{
"name": "properties",
"value": "",
"type": "query",
"description": "This is a special format collection. The string is build using 'customer','shiptocode' as a pair. i.e. MURLEY,0000 as a single item. Each customer set is then collected together using a special delimiter `/*\\` in between each set. If sending the same customer and multiple shiptocodes would be `MURLEY,0000/*\\MURLEY,0001/*\\FRANKES,0210` etc. Should be urlencoded."
},
{
"name": "status",
"value": "",
"type": "query"
},
{
"name": "shunit",
"value": "",
"type": "query",
"description": "Used to search by job unit, must be exact match."
},
{
"name": "barcode",
"value": "",
"type": "query",
"description": "Catalog barcode to search by style & color."
}
]
},
"docs": "Get Installations By Date Range"
},
{
"info": {
"name": "Create Installation Record",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/install",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates Installation Records. Returns the record."
},
{
"info": {
"name": "Get Installation Records",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installs",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query"
},
{
"name": "jobline",
"value": "",
"type": "query"
},
{
"name": "insseq",
"value": "",
"type": "query",
"description": "Will use insseq instead of jobline when not empty."
}
]
},
"docs": "Get Installation Records"
},
{
"info": {
"name": "Installation limits and capacities",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installcapacity",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
}
]
},
"docs": "Installation scheduling limits and capacities"
}
]
},
{
"info": {
"name": "Dashboard",
"type": "folder"
},
"items": [
{
"info": {
"name": "Sales Quicklist",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/dashboardsales",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Sales quicklist by month over date range"
},
{
"info": {
"name": "AR Quicklist",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/dashboardar",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Quicklist for AR buckets"
},
{
"info": {
"name": "AP Quicklist",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/dashboardap",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Quicklist for AP buckets"
},
{
"info": {
"name": "Inventory Valuation Quicklist",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/dashboardinventory",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Inventory Valuation Quicklist"
},
{
"info": {
"name": "Work in Process quicklist",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/dashboardworkinprocess",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "customer",
"value": "",
"type": "query"
}
]
},
"docs": "Work in Process quicklist"
},
{
"info": {
"name": "Fiscal Year Quicklist",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/dashboardfiscal",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Fiscal year sales by period"
}
]
},
{
"info": {
"name": "Pivot",
"type": "folder"
},
"items": [
{
"info": {
"name": "AP Bucket Definitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/accountspayablebuckets",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Bucket definitions for AP"
},
{
"info": {
"name": "AP by Bucket",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/accountspayable",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "bucketstart",
"value": "",
"type": "query"
},
{
"name": "bucketend",
"value": "",
"type": "query"
}
]
},
"docs": "AP by Bucket"
},
{
"info": {
"name": "AR Bucket Definitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/accountsreceivablebuckets",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Bucket definitions for AR"
},
{
"info": {
"name": "AR By Bucket",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/accountsreceivable",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "bucketstart",
"value": "",
"type": "query"
},
{
"name": "bucketend",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Get (I)nvoice or (C)redit items only. Default returns all types."
}
]
},
"docs": "AR By Bucket"
},
{
"info": {
"name": "Sales Volume by Date",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/salesvolume",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
}
]
},
"docs": "Sales Volume by Date"
},
{
"info": {
"name": "Inventory Valuation",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/inventoryvaluation",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Inventory Valuation list"
}
]
},
{
"info": {
"name": "Lead",
"type": "folder"
},
"items": [
{
"info": {
"name": "Lead Time Slots",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadtimeslots",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get lead time slot list"
},
{
"info": {
"name": "Leads list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadsbydate",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Optional Lead status"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Optional Appointment Date"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Optional Appointment Date"
},
{
"name": "startdate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Optional Last Edited Date"
},
{
"name": "enddate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Optional Last Edited Date"
},
{
"name": "startdate3",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Optional Created Date"
},
{
"name": "enddate3",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Optional Created Date"
},
{
"name": "term",
"value": "",
"type": "query",
"description": "Optional Search term for customer name"
},
{
"name": "ordstatuscode",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Leads list by date range"
},
{
"info": {
"name": "Lead detail",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/lead",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "leadno",
"value": "",
"type": "query"
}
]
},
"docs": "Specific Lead information"
},
{
"info": {
"name": "Creates Lead",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/lead",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "rooms[]",
"value": "",
"type": "query",
"description": "Selected Rooms"
},
{
"name": "pctypes[]",
"value": "",
"type": "query",
"description": "Selected Product Types"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates Lead"
},
{
"info": {
"name": "Update lead",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/lead",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "rooms[]",
"value": "",
"type": "query",
"description": "Selected Rooms"
},
{
"name": "pctypes[]",
"value": "",
"type": "query",
"description": "Selected Product Types"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update lead"
},
{
"info": {
"name": "Updates Lead Notes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/leadnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates Lead Notes"
},
{
"info": {
"name": "Updates Lead Quick Note",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/leadquicknote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates Lead Quick Note"
},
{
"info": {
"name": "Updates Lead Disp Style/Quantity Notes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/leaddispoqty",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates Lead Disp Style/Quantity Notes"
},
{
"info": {
"name": "Updates Lead Dispo Notes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/leaddispo",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates Lead Dispo Notes"
},
{
"info": {
"name": "Lead Nonqualified Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadnonq",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "leadno",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Lead Nonqualified Categories - Alert Codes"
},
{
"info": {
"name": "Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/leadnonq",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "nonqdesc",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing Lead Office Note. Returns success message."
},
{
"info": {
"name": "Lead Zone Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadzone",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch specific lead zone info when applicable."
}
]
},
"docs": "Lead zones"
},
{
"info": {
"name": "Subterritory Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/terrsub",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "territory",
"value": "",
"type": "query",
"description": "Optional - enter to return details about one territory"
}
]
},
"docs": "Subterritories"
},
{
"info": {
"name": "Lead Exception Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadexceptions",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "zone",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "salesid",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Optional. Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Optional. Format - YYYYMMDD"
}
]
},
"docs": "Scheduling slot exceptions for lead sales reps"
},
{
"info": {
"name": "Lead Office Notes Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadofficenotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "leadpage",
"value": "",
"type": "query",
"description": "Optional - Lead Office Note Page Number"
}
]
},
"docs": "Get Lead Office Notes"
},
{
"info": {
"name": "Create Lead Office Notes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/leadofficenotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Lead Office Note. Returns success message."
},
{
"info": {
"name": "Update Lead Office Notes",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/leadofficenotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "noteslist",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing Lead Office Note. Returns success message."
},
{
"info": {
"name": "Lead Scheduling Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadsched",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "zone",
"value": "",
"type": "query"
},
{
"name": "salesid",
"value": "",
"type": "query"
},
{
"name": "date",
"value": "",
"type": "query"
}
]
},
"docs": "Scheduling slots for lead sales reps"
},
{
"info": {
"name": "Nonqualified Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/nonqualified",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Nonqualified Categories"
},
{
"info": {
"name": "Lead Mat Type Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadmattype",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Material Type for Leads Product Notes"
},
{
"info": {
"name": "Lead Appointments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadappt",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "salesid",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "leadno",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "leadtime",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Scheduled Lead Appointments"
},
{
"info": {
"name": "Gets Lead Product Notes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadproductnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "leadno",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Returns all lead product notes based on either branch or specific lead number"
},
{
"info": {
"name": "Create Lead Product Notes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/leadproductnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates & returns a new lead product note."
},
{
"info": {
"name": "Updates Lead Product Notes",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/leadproductnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "seq",
"value": "",
"type": "query",
"description": "Format - 0001."
},
{
"name": "pctype",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "mattype",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "room",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "leadmatnote",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Updates an existing lead product note."
},
{
"info": {
"name": "Deletes Lead Product Notes",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/leadproductnotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "seq",
"value": "",
"type": "query",
"description": "Format - 0001."
}
]
},
"docs": "Deletes an existing lead product note by sequence"
},
{
"info": {
"name": "Get Lead Room",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadroom",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "leadno",
"value": "",
"type": "query",
"description": "Optional"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns lead rooms by branch or specific lead number"
},
{
"info": {
"name": "Create Lead Room",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/leadroom",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new lead room for a specific lead number"
},
{
"info": {
"name": "Update Lead Room",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/leadroom",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "room",
"value": "",
"type": "query",
"description": "This is the existing room to be replaced"
},
{
"name": "newroom",
"value": "",
"type": "query",
"description": "The new room replacing the existing room"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Existing Lead Room by Lead Number"
},
{
"info": {
"name": "Remove Lead Room",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/leadroom",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "leadno",
"value": "",
"type": "query"
},
{
"name": "room",
"value": "",
"type": "query",
"description": "This is the existing room to be deleted"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deletes Existing Lead Room by Lead Number"
},
{
"info": {
"name": "Room File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/roomfile",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "room",
"value": "",
"type": "query",
"description": "Optional"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns all rooms by company"
},
{
"info": {
"name": "Get All Availability",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/allavailability",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query"
},
{
"name": "enddate",
"value": "",
"type": "query"
},
{
"name": "salesid",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "zone",
"value": "",
"type": "query",
"description": "optional"
}
]
},
"docs": "Get all available time slots for a specific sales id"
},
{
"info": {
"name": "Get Lead Specials",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/leadspecials",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get Lead Specials"
},
{
"info": {
"name": "Converts an existing lead into a quote",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/convertleadtoquote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Converts an existing lead into a quote"
}
]
},
{
"info": {
"name": "Bundle",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return Bundle(Job/Quote) Name by sequence",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/bundle",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "quote, order (Sets mode of call)"
},
{
"name": "bundleseq",
"value": "",
"type": "query",
"description": "when not sent all"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "required when type is order"
},
{
"name": "quote",
"value": "",
"type": "query",
"description": "required when type is quote"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Return Bundle Name by sequence for a Quote or Job based on 'type' of ('quote' or 'order') or all if no sequence provided"
},
{
"info": {
"name": "Create Bundle(Job/Quote) Record",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/bundle",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "quote, order (Sets mode of call)"
},
{
"name": "bundlename",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "required when type is order"
},
{
"name": "quote",
"value": "",
"type": "query",
"description": "required when type is quote"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates Bundle Record for a Quote or Job based on 'type' of ('quote' or 'order')"
},
{
"info": {
"name": "Update Bundle(Job/Quote) Name by sequence",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/bundle",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "quote, order (Sets mode of call)"
},
{
"name": "bundleseq",
"value": "",
"type": "query",
"description": "sequence to rename"
},
{
"name": "bundlename",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "required when type is order"
},
{
"name": "quote",
"value": "",
"type": "query",
"description": "required when type is quote"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates Bundle Name by sequence for a Quote or Job based on 'type' of ('quote' or 'order')"
}
]
},
{
"info": {
"name": "Quote",
"type": "folder"
},
"items": [
{
"info": {
"name": "Quotes by follow up date range",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/quotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks up Follow-Up Date."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks up Follow-Up Date"
},
{
"name": "startdate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks up Created Date."
},
{
"name": "enddate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks up Created Date."
},
{
"name": "customer",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Optional, open/closed/both"
}
]
},
"docs": "Quotes by follow up date range"
},
{
"info": {
"name": "Get Quote",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/quote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
}
]
},
"docs": "Get Quote header information"
},
{
"info": {
"name": "Create Quote",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/quote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates an Quote. Returns the key (header info) of the Quote updated. Only fields sent will update."
},
{
"info": {
"name": "Update Quote",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/quote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
},
{
"name": "ordstatus",
"value": "",
"type": "query"
},
{
"name": "custpo",
"value": "",
"type": "query"
},
{
"name": "ordcustid",
"value": "",
"type": "query"
},
{
"name": "ordtype",
"value": "",
"type": "query"
},
{
"name": "ordsalesrep1",
"value": "",
"type": "query"
},
{
"name": "ordsalesrep2",
"value": "",
"type": "query"
},
{
"name": "ordjobtype",
"value": "",
"type": "query"
},
{
"name": "ordstatuscode",
"value": "",
"type": "query"
},
{
"name": "shcode",
"value": "",
"type": "query"
},
{
"name": "shname",
"value": "",
"type": "query"
},
{
"name": "shaddr1",
"value": "",
"type": "query"
},
{
"name": "shaddr2",
"value": "",
"type": "query"
},
{
"name": "shctyst",
"value": "",
"type": "query"
},
{
"name": "shcity",
"value": "",
"type": "query"
},
{
"name": "shstate",
"value": "",
"type": "query"
},
{
"name": "shzip",
"value": "",
"type": "query"
},
{
"name": "shbuilding",
"value": "",
"type": "query",
"description": "When used, will override shaddr2 field"
},
{
"name": "shunit",
"value": "",
"type": "query",
"description": "When used, will override shaddr2 field"
},
{
"name": "insdate",
"value": "",
"type": "query",
"description": "YYYYMMDD Changes the follow up date for quote"
}
]
},
"docs": "Updates an existing Quote. Returns the key (header info) of the Quote updated. Only fields sent will update."
},
{
"info": {
"name": "Get quote lines",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/quoteline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query",
"description": "Optional - Sending will return single requested line."
}
]
},
"docs": "Get quote lines"
},
{
"info": {
"name": "Create Quote Line",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/quoteline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a line on an existing quote. Returns the key (header info) of the quote updated.
Only one of these parameters (ordlseq, ordlb2bsku, ordlbarcode) is required. If more than one is passed they execute in the precedence of ordlseq > ordlb2bsku > ordlbarcode"
},
{
"info": {
"name": "Update Quote Line",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/quoteline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
},
{
"name": "ordlwqty",
"value": "",
"type": "query"
},
{
"name": "ordlsqty",
"value": "",
"type": "query"
},
{
"name": "ordlprice",
"value": "",
"type": "query"
},
{
"name": "laborunitcost",
"value": "",
"type": "query"
},
{
"name": "taxable",
"value": "",
"type": "query",
"description": "Y or N"
}
]
},
"docs": "Updates a line on an existing quote. Returns the key (header info) of the quote updated."
},
{
"info": {
"name": "Delete Quote Line",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/quoteline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Deletes a line on an existing quote. Returns the key (header info) of the quote deleted."
},
{
"info": {
"name": "Get Quote line commments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/quotelinecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Get all quote line commments"
},
{
"info": {
"name": "Create Quote Line Comment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/quotelinecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a quote line comment."
},
{
"info": {
"name": "Update Quote Line Comment",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/quotelinecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
},
{
"name": "commseq",
"value": "",
"type": "query"
},
{
"name": "linenote",
"value": "",
"type": "query"
}
]
},
"docs": "Updates an existing quote line comment."
},
{
"info": {
"name": "Reads a Quote Note",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/quotenote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "quote",
"value": "",
"type": "query"
},
{
"name": "jobpage",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Reads a Quote Note"
},
{
"info": {
"name": "Get QRDLSUB Records",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/quotelinesub",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "jobstatus",
"value": "",
"type": "query",
"description": "Optional, open/closed. When not sent open quotes are returned."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "quote",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Get QRDLSUB Records"
}
]
},
{
"info": {
"name": "Inventory",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Catalog Items below Safety Stock Limit",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/lowstock",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
}
]
},
"docs": "Get Catalog Items below Safety Stock Limit"
},
{
"info": {
"name": "Assigned Inventory Received",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/received",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
}
]
},
"docs": "Assigned Inventory Received"
},
{
"info": {
"name": "Get Inventory Point records",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/inventorypointers",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Optional - Format - YYYYMMDD - Use to return records with an audit within specific date range"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Optional - Format - YYYYMMDD - Use to return records with an audit within specific date range"
}
]
},
"docs": "Get all inventory point records for open POs with open PO lines"
},
{
"info": {
"name": "Get Inventory File Records",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/inventorybyauditdate",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks Audit Date in Range."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - - Looks Audit Date in Range."
}
]
},
"docs": "Returns all inventory file records by company, branch, and/or audit date"
},
{
"info": {
"name": "Get Inventory Assigned on Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/assignedinventory",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get Inventory Assigned on Job"
},
{
"info": {
"name": "Assign Inventory to Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/assignedinventory",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign Inventory to Job"
},
{
"info": {
"name": "Unassign Inventory on Job",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/assignedinventory",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
},
{
"name": "invpoint",
"value": "",
"type": "query",
"description": "Full inventory pointer key"
}
]
},
"docs": "Unassign Inventory on Job"
}
]
},
{
"info": {
"name": "Invoice",
"type": "folder"
},
"items": [
{
"info": {
"name": "Invoice Header",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/invoice",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "invoice",
"value": "",
"type": "query",
"description": "Invoice number"
}
]
},
"docs": "Invoice header by invoice number"
},
{
"info": {
"name": "Get Invoice Lines",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/invoicelines",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "invoice",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Invoice Lines"
},
{
"info": {
"name": "Invoice download",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/salesinvoice",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Invoice branch"
},
{
"name": "invoice",
"value": "",
"type": "query",
"description": "6 digit Invoice"
}
]
},
"docs": "Download Sales Invoice PDF"
},
{
"info": {
"name": "Get Invoice Commission Info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/invoicecommission",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "salesid",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
}
]
},
"docs": "Get Invoice Commission Info"
},
{
"info": {
"name": "Get Job Cost Info",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/jobcost",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Job audit date"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Job audit date"
},
{
"name": "startdate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Pay date"
},
{
"name": "enddate2",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Pay date"
}
]
},
"docs": "Get Job Cost Info"
}
]
},
{
"info": {
"name": "Accounts Receivable",
"type": "folder"
},
"items": [
{
"info": {
"name": "AR Notes by Bucket",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/ARNotes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "bucketstart",
"value": "",
"type": "query"
},
{
"name": "bucketend",
"value": "",
"type": "query"
}
]
},
"docs": "AR Notes by Bucket"
},
{
"info": {
"name": "Payment Type Codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/paytypecodes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Payment Type Codes"
},
{
"info": {
"name": "AR Customer Register",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/arcustomerregister",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query"
},
{
"name": "enddate",
"value": "",
"type": "query"
}
]
},
"docs": "AR Customer Register"
},
{
"info": {
"name": "AR Customer Register History",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/arcustomerregisterhistory",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query"
},
{
"name": "enddate",
"value": "",
"type": "query"
}
]
},
"docs": "AR Customer Register History"
}
]
},
{
"info": {
"name": "Reports",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get pre-built sales report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/salesreport",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
}
]
},
"docs": "Get a pre-built sales report for year"
},
{
"info": {
"name": "Get written business report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/writtenbusiness",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
}
]
},
"docs": "Get written business report by date range"
},
{
"info": {
"name": "Get written business report detail",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/writtenbusinessdetail",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
}
]
},
"docs": "Get written business report detail by date range"
}
]
},
{
"info": {
"name": "Audit",
"type": "folder"
},
"items": [
{
"info": {
"name": "Audit create record for order",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/orderauditbydate",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
}
]
},
"docs": "Audit create record for order"
},
{
"info": {
"name": "Audit create record for quote",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/quoteauditbydate",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
}
]
},
"docs": "Audit create record for quote"
}
]
},
{
"info": {
"name": "General Ledger",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get GL Chart of Accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/glchartofaccounts",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get GL Chart of Accounts"
},
{
"info": {
"name": "Get GL Report Format List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/glreportformatlist",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get GL Report Format List"
},
{
"info": {
"name": "Get GL Detail By Period",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/gldetailbyperiod",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "glseq",
"value": "",
"type": "query"
}
]
},
"docs": "Get GL Detail by Period"
},
{
"info": {
"name": "Get GL Detail By Period",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/glperiodtable",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get GL Detail by Period"
}
]
},
{
"info": {
"name": "Handheld",
"type": "folder"
},
"items": [
{
"info": {
"name": "Inventory from barcode scan",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/hhgetinvpointers",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "barcode",
"value": "",
"type": "query"
}
]
},
"docs": "Inventory from barcode scan"
},
{
"info": {
"name": "Inventory by location",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/hhgetinvbylocation",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "location",
"value": "",
"type": "query"
}
]
},
"docs": "Inventory by location"
},
{
"info": {
"name": "View A-J pricing",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/hhgetpricing",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional, gets branch specific pricing when applicable."
},
{
"name": "barcode",
"value": "",
"type": "query"
},
{
"name": "catseq",
"value": "",
"type": "query",
"description": "Barcode or Catseq required to return stock. If both are provided, only catseq is used."
}
]
},
"docs": "View A-J pricing"
},
{
"info": {
"name": "Find PO's by barcode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getposbybarcode",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query"
},
{
"name": "barcode",
"value": "",
"type": "query",
"description": "Inventory or Catalog Barcode, Either Barcode, Vendor, or Referrence Numberis required."
},
{
"name": "vendor",
"value": "",
"type": "query",
"description": "Either Barcode, Vendor, or Referrence Numberis required."
},
{
"name": "refnum",
"value": "",
"type": "query",
"description": "Either Barcode, Vendor, or Referrence Numberis required."
},
{
"name": "createpo",
"value": "",
"type": "query",
"description": "HH User is in Create PO."
}
]
},
"docs": "Find PO's by barcode"
},
{
"info": {
"name": "Find PO's by vendor that can have additional material added",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getposbyvendor",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query"
},
{
"name": "branch",
"value": "",
"type": "query"
}
]
},
"docs": "Find PO's by vendor that can have additional material added"
},
{
"info": {
"name": "Create PO",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/po",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a PO. Returns the key (header info) of the po created."
},
{
"info": {
"name": "Get PO lines",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/poline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "pono",
"value": "",
"type": "query"
}
]
},
"docs": "Get PO lines"
},
{
"info": {
"name": "Create PO Line",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/poline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a line on an existing PO. Returns the key (header info) of the po updated."
},
{
"info": {
"name": "Update PO Line",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/poline",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "pono",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
},
{
"name": "ordlwqty",
"value": "",
"type": "query"
},
{
"name": "unitcost",
"value": "",
"type": "query"
},
{
"name": "unitfreight",
"value": "",
"type": "query"
},
{
"name": "overbill",
"value": "",
"type": "query"
},
{
"name": "memo",
"value": "",
"type": "query"
},
{
"name": "refnum",
"value": "",
"type": "query"
},
{
"name": "reservenum",
"value": "",
"type": "query"
},
{
"name": "smop",
"value": "",
"type": "query"
},
{
"name": "freightterms",
"value": "",
"type": "query"
},
{
"name": "shipvia",
"value": "",
"type": "query"
},
{
"name": "minqty",
"value": "",
"type": "query"
},
{
"name": "maxqty",
"value": "",
"type": "query"
},
{
"name": "canceldays",
"value": "",
"type": "query"
},
{
"name": "shipdate",
"value": "",
"type": "query"
},
{
"name": "leaddays",
"value": "",
"type": "query"
},
{
"name": "arrivedate",
"value": "",
"type": "query"
},
{
"name": "dye",
"value": "",
"type": "query"
},
{
"name": "ordsalesrep1",
"value": "",
"type": "query"
},
{
"name": "rollcutqty",
"value": "",
"type": "query"
}
]
},
"docs": "Updates a line on an existing po. Returns the key (header info) of the po updated."
},
{
"info": {
"name": "Read WO lines from barcode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/wolines",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query",
"description": "Work Order barcode"
}
]
},
"docs": "Read WO lines from barcode"
},
{
"info": {
"name": "Read WO header from barcode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/wo",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query",
"description": "Work Order barcode"
}
]
},
"docs": "Read WO header from barcode"
},
{
"info": {
"name": "Assign Inventory",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/assign",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign Inventory"
},
{
"info": {
"name": "Unassign Inventory",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/assign",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query",
"description": "Job number - REQUIRED when bo is not sent. When both bo and job are filled job will be used."
},
{
"name": "bo",
"value": "",
"type": "query",
"description": "Build order number - REQUIRED when job is not sent. When both bo and job are filled job will be used."
},
{
"name": "lnnum",
"value": "",
"type": "query",
"description": "Line number being unassigned."
},
{
"name": "invpoint",
"value": "",
"type": "query",
"description": "Full inventory pointer key"
}
]
},
"docs": "Unassign Inventory"
},
{
"info": {
"name": "Ships Work Order",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/ship",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Ships Work Order and creates a shipped revision"
},
{
"info": {
"name": "Inventory Locations from barcode scan",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/hhgetlocations",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query"
}
]
},
"docs": "Inventory locations barcode scan"
},
{
"info": {
"name": "Get unpicked inventory",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/unpicked",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "invkey",
"value": "",
"type": "query"
}
]
},
"docs": "Get unpicked inventory"
},
{
"info": {
"name": "Get inventory comments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/inventorycomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get inventory comments"
},
{
"info": {
"name": "Find temporary inventory barcode.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/tempbarcode",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query"
}
]
},
"docs": "Find temporary inventory barcode."
},
{
"info": {
"name": "Get user barcode settings.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/barcodesettings",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Get user barcode settings."
},
{
"info": {
"name": "Get staged revisions list",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/stagedrevisions",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "barcode",
"value": "",
"type": "query"
}
]
},
"docs": "Get staged revisions list"
},
{
"info": {
"name": "Convert Inventory Quantity",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/convertinvqty",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "barcode",
"value": "",
"type": "query",
"description": "Catalog or Inevntory barcode."
},
{
"name": "ordlwqty",
"value": "",
"type": "query"
},
{
"name": "box",
"value": "",
"type": "query",
"description": "Send Y when converting box qty to invetory qty."
}
]
},
"docs": "Convert Inventory Quantity"
}
]
},
{
"info": {
"name": "Purchase Order",
"type": "folder"
},
"items": [
{
"info": {
"name": "Update PO",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/po",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "pono",
"value": "",
"type": "query"
},
{
"name": "vendor",
"value": "",
"type": "query"
},
{
"name": "ordstatus",
"value": "",
"type": "query",
"description": "C will cancel PO."
},
{
"name": "date",
"value": "",
"type": "query",
"description": "MMDDYYYY Format"
},
{
"name": "terms",
"value": "",
"type": "query"
},
{
"name": "orderedby",
"value": "",
"type": "query"
},
{
"name": "takenby",
"value": "",
"type": "query"
},
{
"name": "refnum",
"value": "",
"type": "query"
},
{
"name": "stoporder",
"value": "",
"type": "query",
"description": "Y"
},
{
"name": "allocated",
"value": "",
"type": "query",
"description": "1 for Yes, 0 for No"
},
{
"name": "exchangerate",
"value": "",
"type": "query"
},
{
"name": "includegross",
"value": "",
"type": "query",
"description": "1 for Yes, 0 for No"
},
{
"name": "includefreight",
"value": "",
"type": "query",
"description": "1 for Yes, 0 for No"
},
{
"name": "exchangefreight",
"value": "",
"type": "query"
},
{
"name": "exchangecost1",
"value": "",
"type": "query"
},
{
"name": "exchangecost2",
"value": "",
"type": "query"
},
{
"name": "exchangecost3",
"value": "",
"type": "query"
},
{
"name": "includecost1",
"value": "",
"type": "query",
"description": "1 for Yes, 0 for No"
},
{
"name": "includecost2",
"value": "",
"type": "query",
"description": "1 for Yes, 0 for No"
},
{
"name": "includecost3",
"value": "",
"type": "query",
"description": "1 for Yes, 0 for No"
},
{
"name": "enableexpcost",
"value": "",
"type": "query",
"description": "1 for Yes, 0 for No"
}
]
},
"docs": "Updates an existing po."
},
{
"info": {
"name": "Read purchase order lines that are open",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/purchaseorderlines",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Read purchase order lines that are open"
},
{
"info": {
"name": "Purchase order detail",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/purchaseorderheader",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "ponumber",
"value": "",
"type": "query",
"description": "PO number requested"
}
]
},
"docs": "Purchase order detail"
},
{
"info": {
"name": "List of purchase orders by date",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/purchaseorderheaders",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD"
},
{
"name": "lastdays",
"value": "",
"type": "query",
"description": "Last X days of data to call for. Same as calling for startdate through enddate of X days ago to today. Call for either startdate/enddate OR lastdays. Lastdays WILL OVERRIDE startdate/enddate."
},
{
"name": "vendor",
"value": "",
"type": "query",
"description": "Vendors to filter by"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status codes to filter by"
}
]
},
"docs": "List of purchase orders by date"
},
{
"info": {
"name": "PO Shipvia",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/shipvia",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "PO Shipvia List"
},
{
"info": {
"name": "PO Freight Terms",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/freightterms",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "PO Freight Terms List"
},
{
"info": {
"name": "PO Shipment Method of Payment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/smop",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "PO Shipment Method of Payment List"
},
{
"info": {
"name": "Vendor Type List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/vendortypes",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Venndor Type List"
},
{
"info": {
"name": "Customer Type List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/customertype",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Customer Type List"
},
{
"info": {
"name": "Reads PO Notes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/ponote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Reads PO Notes"
},
{
"info": {
"name": "Creates a PO Note",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/ponote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a PO Note"
},
{
"info": {
"name": "Edits a PO Note",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/ponote",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "note",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Edits a PO Note"
},
{
"info": {
"name": "Get PO line commments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/polinecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "job",
"value": "",
"type": "query"
},
{
"name": "lnnum",
"value": "",
"type": "query"
}
]
},
"docs": "Get all PO line commments"
},
{
"info": {
"name": "Create PO Line Comment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/polinecomments",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates an PO line comment."
},
{
"info": {
"name": "Get PO Pointers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/popointers",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get all PO Pointers"
},
{
"info": {
"name": "Get Purchase Order File Data - SQL Format",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/pos",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Optional - When neither C (closed) or O (open) is sent only open purchase orders are returned."
},
{
"name": "po",
"value": "",
"type": "query",
"description": "Optional - purchase order number"
}
]
},
"docs": "Get Purchase Order File Data - SQL Format"
}
]
},
{
"info": {
"name": "ChargeItPro",
"type": "folder"
},
"items": [
{
"info": {
"name": "ChargeItPro summary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/cip_summary",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "bucket/summary chargeitpro transaction data"
}
]
},
{
"info": {
"name": "Vendor",
"type": "folder"
},
"items": [
{
"info": {
"name": "Vendor Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/vendors",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page."
},
{
"name": "pagelimit",
"value": "",
"type": "query",
"description": "Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return."
},
{
"name": "vendor",
"value": "",
"type": "query",
"description": "Optional - Used to return speciific vendor details"
},
{
"name": "term",
"value": "",
"type": "query",
"description": "Optional - Used to search Vendor ID and Name"
}
]
},
"docs": "Vendor Details"
},
{
"info": {
"name": "Get Vendor Contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/vendorcontacts",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "vendor",
"value": "",
"type": "query",
"description": "Optional - use to return contact details for a single vendor"
}
]
},
"docs": "Get contact details for a single vendor or multiple vendors"
}
]
},
{
"info": {
"name": "Committed",
"type": "folder"
},
"items": [
{
"info": {
"name": "Committed Inventory",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/committed",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
}
]
},
"docs": "Stocking items with committed inventory"
}
]
},
{
"info": {
"name": "General",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get records from the customer, customer address, customer contacts, leads, and vendor records based on phone number.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/searchbyphone",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "term",
"value": "",
"type": "query",
"description": "Phone number in 111-111-1111 format."
}
]
},
"docs": "Get records from the customer, customer address, customer contacts, leads, and vendor records based on phone number."
},
{
"info": {
"name": "Get records for contacts created on or after date sent.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/contactcreation",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "date",
"value": "",
"type": "query",
"description": "Date in YYYYMMDD format."
}
]
},
"docs": "Get records for contacts created on or after date sent."
},
{
"info": {
"name": "Get web storage objects per user",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/webstorages",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "Company ID, can be passed as a blank for all companies"
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Branch ID, can be passed as blank or not submitted to return all branches"
}
]
},
"docs": "Get web storage objects per user. Used for long term storage of web items that would normally end up in localStorage or Session objects"
},
{
"info": {
"name": "Get web storage objects per user",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/webstorage",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "Company ID, can be passed as a blank for all companies"
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Branch ID, can be passed as blank or not submitted to return all branches"
},
{
"name": "SETTING",
"value": "",
"type": "query",
"description": "Setting ID, must be unique"
}
]
},
"docs": "Get web storage objects per user. Used for long term storage of web items that would normally end up in localStorage or Session objects"
},
{
"info": {
"name": "Create webstorage object",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.rmaster.com/api/:alias/webstorage",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create webstorage object for username, setting, and value."
},
{
"info": {
"name": "Update webstorage object",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.rmaster.com/api/:alias/webstorage",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "Company ID"
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Branch ID"
},
{
"name": "SETTING",
"value": "",
"type": "query",
"description": "Setting ID, must be unique"
},
{
"name": "VALUE",
"value": "",
"type": "query"
}
]
},
"docs": "Update webstorage object for username, setting, and value."
},
{
"info": {
"name": "Update webstorage object",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.rmaster.com/api/:alias/webstorage",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "Company ID"
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Branch ID"
},
{
"name": "SETTING",
"value": "",
"type": "query",
"description": "Setting ID, must be unique"
}
]
},
"docs": "Update webstorage object for username, setting, and value."
}
]
},
{
"info": {
"name": "Build Order",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get BM File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/buildorders",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "ordstatus",
"value": "",
"type": "query",
"description": "Appending and using I returns closed orders, using A returns open and closed orders."
}
]
},
"docs": "Get BM File"
},
{
"info": {
"name": "Get Build Order Lines File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/buildorderlines",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "ordstatus",
"value": "",
"type": "query",
"description": "Appending and using I returns closed orders, using A returns open and closed orders."
}
]
},
"docs": "Returns Build Order Lines"
},
{
"info": {
"name": "Get Build Order Point File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/buildorderpoint",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "ordstatus",
"value": "",
"type": "query",
"description": "Appending and using I returns closed orders, using A returns open and closed orders."
}
]
},
"docs": "Returns Build Order Point Records"
},
{
"info": {
"name": "Get Order-Related Build Order Lines",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/orderrelatedbolines",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Optional"
},
{
"name": "startdate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - Looks Audit Date in Range."
},
{
"name": "enddate",
"value": "",
"type": "query",
"description": "Format - YYYYMMDD - - Looks Audit Date in Range."
},
{
"name": "ordstatus",
"value": "",
"type": "query",
"description": "Appending and using I returns closed orders, using A returns open and closed orders."
}
]
},
"docs": "Returns order-related build order lines by company, branch, order number, and/or audit date"
}
]
},
{
"info": {
"name": "Logo",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Installer Logo",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/installerlogo",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "installer",
"value": "",
"type": "query",
"description": "Optional"
}
]
},
"docs": "Get Installer Logo"
},
{
"info": {
"name": "Get Logo",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/getlogo",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "doctype",
"value": "",
"type": "query",
"description": "Required - returns specific logo information for Agreement (O), Invoice (I), or Quote (Q)."
}
]
},
"docs": "Get header and footer logo information by company, branch and document type"
},
{
"info": {
"name": "Get Logo settings bu document type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.rmaster.com/api/:alias/logosettings",
"params": [
{
"name": "alias",
"value": "",
"type": "path",
"description": "The clientid for the API call."
},
{
"name": "company",
"value": "",
"type": "query",
"description": "RollMaster company."
},
{
"name": "branch",
"value": "",
"type": "query",
"description": "RollMaster branch."
},
{
"name": "doctype",
"value": "",
"type": "query",
"description": "Required - returns specific logo information for Agreement (O), Invoice (I), or Quote (Q)."
}
]
},
"docs": "Get Logo settings bu document type"
}
]
}
],
"bundled": true
}