openapi: 3.1.0 info: title: Broadlume BMS API version: v1 summary: Business management API for Broadlume BMS, the flooring ERP formerly known as RollMaster. description: 'REST API for Broadlume BMS (formerly RollMaster), Broadlume''s business management system for flooring retailers. Covers orders, quotes, leads, customers, products and catalog, inventory, purchase orders, invoicing, accounts receivable, general ledger, installation scheduling, e-documents, handheld/barcode operations, dashboards and reporting. Transcribed by API Evangelist from Broadlume''s own published developer portal at https://developer.broadlume.com/bms — paths, methods, parameters and response fields are taken verbatim from that reference. Broadlume acquired RollMaster in November 2021, which is why the documented base URL remains api.rmaster.com.' contact: name: Broadlume Developer Portal url: https://developer.broadlume.com/bms externalDocs: description: Broadlume BMS developer portal url: https://developer.broadlume.com/bms servers: - url: https://api.rmaster.com/api description: Production security: - apiKeyAuth: [] sessionToken: [] tags: - name: Version - name: Authentication - name: Order - name: Customer - name: Company - name: Product - name: Retail Pricing - name: Edocs - name: Install - name: Dashboard - name: Pivot - name: Lead - name: Bundle - name: Quote - name: Inventory - name: Invoice - name: Accounts Receivable - name: Reports - name: Audit - name: General Ledger - name: Handheld - name: Purchase Order - name: ChargeItPro - name: Vendor - name: Committed - name: General - name: Build Order - name: Logo paths: /{alias}/version: get: operationId: apiVersion summary: API Version tags: - Version description: API version parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. responses: '200': description: OK content: application/json: schema: type: object properties: VERSION: type: string /{alias}/token: post: operationId: authenticateUserCreateSession summary: Authenticate User / Create Session tags: - Authentication description: 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. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: username: type: string maxLength: 8 description: User name password: type: string maxLength: 8 description: User password granttype: type: string default: client enum: - application - client description: Token grant type (application or client). Client tokens will time out at a specified amount of minutes and need to have active calls made or a GET token endpoint called to keep it active. Once client tokens expire, they are invalid. Application tokens are long term token used for API to API transactions and do not time out if used within a year of creation. required: - username - password responses: '200': description: OK content: application/json: schema: type: object properties: COMPANIES: type: array items: type: array items: type: string TOKEN: type: string get: operationId: sessionKeepalive summary: Session Keepalive tags: - Authentication description: 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. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. responses: '200': description: OK content: application/json: schema: type: object properties: RETURN: type: string delete: operationId: removeSession summary: Remove Session tags: - Authentication description: 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. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: granttype: type: string default: client enum: - application - client description: Token grant type (application or client). Client tokens will time out at a specified amount of minutes and need to have active calls made or a GET token endpoint called to keep it active. Once client tokens expire, they are invalid. Application tokens are long term token used for API to API transactions and do not time out if used within a year of creation. responses: '200': description: OK content: application/json: schema: type: object properties: RETURN: type: string /{alias}/sessioncount: get: operationId: sessionCount summary: Session Count tags: - Authentication description: Currently active session count and limit parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. responses: '200': description: OK content: application/json: schema: type: object properties: SESSIONCOUNT: type: string LIMIT: type: string /{alias}/permissions: get: operationId: userPermissions summary: User permissions tags: - Authentication description: User web permissions parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/changebranch: post: operationId: changeBranches summary: Change Branches tags: - Authentication description: Change currently active branches parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: array items: type: array items: type: string description: Collection of all arrays that are to be set 'active'. All branches not passed will be set to inactive by default. Subsequent queries will use the list of active branches to filter the returns. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/order: post: operationId: createOrder summary: Create Order tags: - Order description: Creates an order. Returns the successfully created order. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. custpo: type: string maxLength: 15 description: Required when customer ship to requires. ordcustid: type: string maxLength: 8 ordsalesrep1: type: string maxLength: 3 description: Note - assumes user salesperson initials if not sent and if user is salesperson. ordsalesrep2: type: string maxLength: 3 ordjobtype: type: string maxLength: 2 ordstatuscode: type: string maxLength: 10 shcode: type: string maxLength: 4 description: Ship to code of 0000 is assumed when not sent. shname: type: string maxLength: 30 description: Ship to information is assumed when not sent. shaddr1: type: string maxLength: 30 description: Ship to information is assumed when not sent. shaddr2: type: string maxLength: 30 description: Ship to information is assumed when not sent. shctyst: type: string maxLength: 30 description: Ship to information is assumed when not sent. shcity: type: string maxLength: 30 description: Ship to information is assumed when not sent. shstate: type: string maxLength: 30 description: Ship to information is assumed when not sent. shzip: type: string maxLength: 10 description: Ship to information is assumed when not sent. shbuilding: type: string maxLength: 23 description: When used, will override first section of shaddr2 field shunit: type: string maxLength: 6 description: When used, will override last section of shaddr2 field insdate: type: string maxLength: 8 description: Format - YYYYMMDD - Changes the single install date for a job (does not function with multi-date records) or when capacities are turned on. time: type: string maxLength: 8 description: Changes the install time for a job (does not function with multi-date records) or when capacities are turned on. initials: type: string maxLength: 1 description: Required when company control is turned on and install date is sent. phone1: type: string maxLength: 30 description: Ship to Phone phone2: type: string maxLength: 30 description: Ship to Fax email: type: string maxLength: 100 description: Ship to Email typedesc: type: string maxLength: 10 description: Ship to Type Description required: - company - branch - ordcustid - ordsalesrep1 - ordjobtype - ordstatuscode responses: '200': description: OK content: application/json: schema: type: object properties: DMO_CODIV: type: string DMO_WHSE: type: string DMH_CUSTID: type: string DMH_SHNAME: type: string DMH_SHCODE: type: string DMH_SHADDR1: type: string DMH_SHADDR2: type: string DMH_SHCTYST: type: string DMH_SHZIP: type: string DMH_SALESREP1: type: string DMH_SALESREP2: type: string DMH_SPECIAL1: type: string DMH_CUSTPO: type: string DMH_QRDNO: type: string DMH_STATUSCODE: type: string DMH_DATE: type: string DMH_INSTALLDATE: type: string DMH_SHPHONE1: type: string DMH_SHFAX: type: string DMH_SHCONTACT: type: string DMH_ORDEREDBY: type: string DMH_INSTALL_TIME: type: string SAL_NAME: type: string PODMO_WEB_USER: type: string DMH_JOBTOTAL: type: string DMH_BLDG: type: string DMH_UNIT: type: string DMH_SHCITY: type: string DMH_SHSTATE: type: string patch: operationId: updateOrder summary: Update Order tags: - Order description: Updates an existing order. Returns the key (header info) of the order updated. Only fields sent will update. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 - name: custpo in: query required: false schema: type: string maxLength: 15 description: Required when customer ship to requires and not already filled for existing ship to code. - name: ordcustid in: query required: false schema: type: string maxLength: 8 - name: ordsalesrep1 in: query required: false schema: type: string maxLength: 3 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 in: query required: false schema: type: string maxLength: 3 - name: ordjobtype in: query required: false schema: type: string maxLength: 2 description: Required when not already filled. - name: ordstatuscode in: query required: false schema: type: string maxLength: 10 description: Required when not already filled. - name: shcode in: query required: false schema: type: string maxLength: 4 description: Ship to code of 0000 is assumed when not sent and info has not been filled or when changing customer. - name: shname in: query required: false schema: type: string maxLength: 30 description: Ship to information is assumed when changing ship to code or customer and info has not been sent. - name: shaddr1 in: query required: false schema: type: string maxLength: 30 description: Ship to information is assumed when changing ship to code or customer and info has not been sent. - name: shaddr2 in: query required: false schema: type: string maxLength: 30 description: Ship to information is assumed when changing ship to code or customer and info has not been sent. - name: shctyst in: query required: false schema: type: string maxLength: 30 description: Ship to information is assumed when changing ship to code or customer and info has not been sent. - name: shcity in: query required: false schema: type: string maxLength: 30 description: Ship to information is assumed when changing ship to code or customer and info has not been sent. - name: shstate in: query required: false schema: type: string maxLength: 30 description: Ship to information is assumed when changing ship to code or customer and info has not been sent. - name: shzip in: query required: false schema: type: string maxLength: 10 description: Ship to information is assumed when changing ship to code or customer and info has not been sent. - name: shbuilding in: query required: false schema: type: string maxLength: 23 description: When used, will override first section of shaddr2 field - name: shunit in: query required: false schema: type: string maxLength: 6 description: When used, will override last section of shaddr2 field - name: insdate in: query required: false schema: type: string maxLength: 8 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 in: query required: false schema: type: string maxLength: 1 description: Changes the install time for a job (does not function with multi-date records) or when capacities are turned on. - name: initials in: query required: false schema: type: string maxLength: 3 description: Required when company control is turned on and install date is sent. requestBody: required: true content: application/json: schema: type: object properties: phone1: type: string maxLength: 30 description: Ship to Phone phone2: type: string maxLength: 30 description: Ship to Fax email: type: string maxLength: 100 description: Ship to Email typedesc: type: string maxLength: 10 description: Ship to Type Description responses: '200': description: OK content: application/json: schema: type: object properties: DMO_CODIV: type: string DMO_WHSE: type: string DMH_CUSTID: type: string DMH_SHNAME: type: string DMH_SHCODE: type: string DMH_SHADDR1: type: string DMH_SHADDR2: type: string DMH_SHCTYST: type: string DMH_SHZIP: type: string DMH_SALESREP1: type: string DMH_SALESREP2: type: string DMH_SPECIAL1: type: string DMH_CUSTPO: type: string DMH_QRDNO: type: string DMH_STATUSCODE: type: string DMH_DATE: type: string DMH_INSTALLDATE: type: string DMH_SHPHONE1: type: string DMH_SHFAX: type: string DMH_SHCONTACT: type: string DMH_ORDEREDBY: type: string DMH_INSTALL_TIME: type: string SAL_NAME: type: string PODMO_WEB_USER: type: string DMH_JOBTOTAL: type: string DMH_BLDG: type: string DMH_UNIT: type: string DMH_SHCITY: type: string DMH_SHSTATE: type: string get: operationId: getOrder summary: Get Order tags: - Order description: Get order header information parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 responses: '200': description: OK content: application/json: schema: type: object properties: DMO_CODIV: type: string DMO_WHSE: type: string DMH_CUSTID: type: string DMH_SHNAME: type: string DMH_SHCODE: type: string DMH_SHADDR1: type: string DMH_SHADDR2: type: string DMH_SHCTYST: type: string DMH_SHZIP: type: string DMH_SALESREP1: type: string DMH_SALESREP2: type: string DMH_SPECIAL1: type: string DMH_CUSTPO: type: string DMH_QRDNO: type: string DMH_STATUSCODE: type: string DMH_DATE: type: string DMH_INSTALLDATE: type: string DMH_SHPHONE1: type: string DMH_SHFAX: type: string DMH_SHCONTACT: type: string DMH_ORDEREDBY: type: string DMH_INSTALL_TIME: type: string SAL_NAME: type: string PODMO_WEB_USER: type: string DMH_JOBTOTAL: type: string DMH_BLDG: type: string DMH_UNIT: type: string DMH_SHCITY: type: string DMH_SHSTATE: type: string /{alias}/orderlineinstaller: patch: operationId: updateOrderLineInstallerSingleDateOnly summary: Update Order Line Installer (Single Date Only) tags: - Order description: Sets/updates the installer for a single labor line
Single Intall Date Only parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 - name: lnnum in: query required: true schema: type: string maxLength: 3 - name: installer in: query required: true schema: type: string maxLength: 8 - name: taxable in: query required: false schema: type: string maxLength: 1 description: Y or N responses: '200': description: OK content: application/json: schema: type: object properties: RETURN: type: string /{alias}/orderline: get: operationId: getOrderLinesInactiveUntil2102Release summary: Get Order Lines - Inactive until 2102 Release tags: - Order description: Get Order Lines - Inactive until 2102 Release parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: false schema: type: string maxLength: 6 description: Required When Audit Date Is Not Sent. - name: status in: query required: false schema: type: string default: open enum: - open - closed - both description: Job Status. - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks at Job Audit Date in Range. - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - - Looks at Job Audit Date in Range. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string post: operationId: createOrderLine summary: Create Order Line tags: - Order description: 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 parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. order: type: string maxLength: 6 ordlseq: type: string maxLength: 13 description: Catalog sequence ordlb2bsku: type: string maxLength: 30 ordlbarcode: type: string maxLength: 30 ordlwqty: type: string maxLength: 9 ordlsqty: type: string maxLength: 9 ordlprice: type: string maxLength: 9 laborunitcost: type: string maxLength: 9 taxable: type: string maxLength: 1 description: Y or N required: - company - branch - order responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/salesreps: get: operationId: salesReps summary: Sales Reps tags: - Order description: Sales Rep list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/ordertype: get: operationId: orderTypeList summary: Order Type List tags: - Order description: Order Type list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/accumcode: get: operationId: accumulatorCodeList summary: Accumulator Code List tags: - Order description: Accumulator Code List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/ordertimeslots: get: operationId: orderTimeSlotList summary: Order Time Slot List tags: - Order description: Order Time Slot List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/orders: get: operationId: ordersByDateRange summary: Orders by date range tags: - Order description: Orders by date range parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: custid in: query required: false schema: type: string maxLength: 8 - name: ordstatus in: query required: false schema: type: string maxLength: 1 description: Appending and using I returns closed orders, using A returns open and closed orders. - name: shaddr1 in: query required: false schema: type: string maxLength: 30 description: Searches shipto address 1 and 2, used only when startswith is not sent. - name: startswith in: query required: false schema: type: string maxLength: 30 description: Searches shipto address 1 and 2, used only when shaddr1 is not sent. - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD, required when searching with shaddr1, or when startswith is not sent. - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD, required when searching with shaddr1, or when startswith is not sent. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/invoicedue: get: operationId: agingInvoices summary: Aging Invoices tags: - Order description: Aging Invoices parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: days in: query required: false schema: type: string maxLength: 3 description: Days Old responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/linecomments: post: operationId: createOrderLineComment summary: Create Order Line Comment tags: - Order description: Creates an order line comment. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. job: type: string maxLength: 6 lnnum: type: string maxLength: 3 linenote: type: string maxLength: 70 commenttype: type: string maxLength: 1 description: W = work order, C = customer, B= both, N = none required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: OLC_CODIV: type: string OLC_WHSE: type: string OLC_ORDNO: type: string OLC_LNNUM: type: string OLC_SEQ: type: string OLC_TYPE: type: string OLC_COMMENT: type: string OLC_WEBNAME: type: string OLC_DATE: type: string OLC_TIME: type: string OLC_REQUIRED: type: string OLC_NOTE_NUM: type: string patch: operationId: updateOrderLineComment summary: Update Order Line Comment tags: - Order description: Updates an existing order line comment. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: false schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 - name: commseq in: query required: false schema: type: string maxLength: 3 - name: linenote in: query required: false schema: type: string maxLength: 53 responses: '200': description: OK content: application/json: schema: type: object properties: OLC_CODIV: type: string OLC_WHSE: type: string OLC_ORDNO: type: string OLC_LNNUM: type: string OLC_SEQ: type: string OLC_TYPE: type: string OLC_COMMENT: type: string OLC_WEBNAME: type: string OLC_DATE: type: string OLC_TIME: type: string OLC_REQUIRED: type: string OLC_NOTE_NUM: type: string get: operationId: getOrderLineCommments summary: Get order line commments tags: - Order description: Get all order line commments parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: false schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string delete: operationId: deleteOrderLineCommment summary: Delete order line commment tags: - Order description: Delete order line comment parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: false schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 - name: commseq in: query required: false schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/jobnote: post: operationId: createsAJobNote summary: Creates a Job Note tags: - Order description: Creates a Job Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. order: type: string maxLength: 6 note: type: string maxLength: 59 required: - company - branch - order - note responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string ORDNO: type: string PAGE: type: string LINE: type: string NOTE: type: string patch: operationId: editsAJobNote summary: Edits a Job Note tags: - Order description: Edits a Job Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 - name: note in: query required: true schema: type: string maxLength: 59 - name: page in: query required: true schema: type: string maxLength: 2 - name: lnnum in: query required: true schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string ORDNO: type: string PAGE: type: string LINE: type: string NOTE: type: string get: operationId: readsAJobNote summary: Reads a Job Note tags: - Order description: Reads a Job Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 - name: jobpage in: query required: false schema: type: string maxLength: 2 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string ORDNO: type: string PAGE: type: string LINE: type: string NOTE: type: string delete: operationId: erasesAJobNote summary: Erases a Job Note tags: - Order description: Erases a Job Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 - name: lnnum in: query required: true schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BRANCH: type: string ORDER: type: string PAGE: type: string LINE: type: string NOTE: type: string /{alias}/initials: get: operationId: listOfInitials summary: List of Initials tags: - Order description: List of Initials parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/jobstats: get: operationId: jobStatusList summary: Job Status List tags: - Order description: Job Status List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: jobstat in: query required: false schema: type: string maxLength: 10 - name: jstattype in: query required: false schema: type: string maxLength: 10 description: Job Status types - order, quote, lead, spaces returns all responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/regiontax: get: operationId: getRegionTaxCodes summary: Get Region Tax Codes tags: - Order description: Get Region tax codes by company and/or region parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: region in: query required: false schema: type: string maxLength: 20 description: Optional - use to return tax details for a single region responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/commissiondetails: get: operationId: getSalesRepCommissionDetails summary: Get Sales Rep Commission Details tags: - Order description: Get Sales Rep Commission Details parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch specific commission info when applicable. - name: salesid in: query required: false schema: type: string maxLength: 3 description: Optional - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/taxcode: get: operationId: taxCodeDetails summary: Tax Code Details tags: - Order description: Get tax code details by company parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: taxcode in: query required: false schema: type: string maxLength: 8 description: Optional - name: startdate in: query required: false schema: type: string maxLength: 8 description: Last Edit Date - Format - YYYYMMDD - name: enddate in: query required: false schema: type: string maxLength: 8 description: Last Edit Date - Format - YYYYMMDD - name: alphanumericstart in: query required: false schema: type: string maxLength: 1 - name: alphanumericend in: query required: false schema: type: string maxLength: 1 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/orderlinesub: get: operationId: getOrdlsubRecords summary: Get ORDLSUB Records tags: - Order description: Get ORDLSUB Records parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: jobstatus in: query required: false schema: type: string maxLength: 7 description: Optional, open/closed. When not sent open and closed jobs are returned. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: job in: query required: false schema: type: string maxLength: 6 description: Optional - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customers: get: operationId: customerList summary: Customer List tags: - Customer description: 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. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: false schema: type: string maxLength: 8 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 in: query required: false schema: type: string maxLength: 8 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 in: query required: false schema: type: string maxLength: 2 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 in: query required: false schema: type: string maxLength: 2 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 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks customer creation date. - name: enddate2 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks customer creation date. - name: lastdays in: query required: false schema: type: string maxLength: 4 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 in: query required: false schema: type: string maxLength: 3 - name: salesid2 in: query required: false schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customer: get: operationId: customerInfo summary: Customer info tags: - Customer description: Get customer info. Either customer or customername are required. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: false schema: type: string maxLength: 8 description: (required if customername is not passed) References the customer id field. Leading spaces need to be filled with websafe spacing. - name: customername in: query required: false schema: type: string maxLength: 30 description: (required if customer is not passed) References the customer name. Spaces need to be filled with websafe spacing. responses: '200': description: OK content: application/json: schema: type: object properties: C_CID: type: string C_NAME: type: string C_ADDR1: type: string C_ADDR2: type: string C_CTYST: type: string C_ZIPCD: type: string C_PHONE: type: string C_TERRFLAG: type: string C_TERR: type: string C_DAYS: type: string C_NET: type: string C_FINCHG: type: string C_CHGPCT: type: string C_CHGDAYS: type: string C_STAT: type: string C_CRSTATUS: type: string C_CONTACT: type: string C_PHONE2: type: string C_FAX: type: string C_TAXID: type: string C_CURR_CREDIT: type: string C_CURR_CREDIT_FLOAT: type: string C_CURR_CREDIT_DISP: type: string C_TERMS: type: string C_SALES: type: string C_YTD_SALES: type: string C_PREVYRSLS: type: string C_CRLIMIT: type: string C_DATE_OPEN: type: string C_LAST_PAY: type: string C_LAST_INV: type: string C_LAST_ORDER: type: string C_EMAIL: type: string C_TERMS_DISP: type: string C_AVG_PAY: type: string C_ONORDER: type: string C_ARDUE: type: string C_CITY: type: string C_STATE: type: string C_COUNTRY: type: string C_PRICE: type: string SAL_NAME: type: string C_CUSTTYPE: type: string post: operationId: customerInfo1 summary: Customer info tags: - Customer description: Create customer. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: COMPANY: type: string maxLength: 2 C_CID: type: string maxLength: 8 C_WHSE: type: string maxLength: 2 C_NAME: type: string maxLength: 30 C_ADDR1: type: string maxLength: 100 C_ADDR2: type: string maxLength: 100 C_ZIPCD: type: string maxLength: 10 C_PHONE: type: string maxLength: 15 description: Format '999-999-9999' C_TERRFLAG: type: string maxLength: 30 C_TERR: type: string maxLength: 30 C_STAT: type: string maxLength: 30 C_CONTACT: type: string maxLength: 30 C_PHONE2: type: string maxLength: 15 description: Format '999-999-9999' C_FAX: type: string maxLength: 30 description: Format '999-999-9999' C_TAXID: type: string maxLength: 30 C_SLSID: type: string maxLength: 30 C_EMAIL: type: string maxLength: 100 C_PRICE_LEVEL_DEFAULT: type: string maxLength: 30 C_CUSTTYPE: type: string maxLength: 30 C_PROMPMGMT_CO: type: string maxLength: 30 C_NAME_LONG: type: string maxLength: 100 C_CITY: type: string maxLength: 30 C_STATE: type: string maxLength: 30 required: - COMPANY - C_CID - C_WHSE - C_NAME responses: '200': description: OK content: application/json: schema: type: object properties: RETURN: type: string patch: operationId: customerInfo2 summary: Customer info tags: - Customer description: Update customer. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: COMPANY: type: string maxLength: 2 C_CID: type: string maxLength: 8 C_WHSE: type: string maxLength: 2 C_NAME: type: string maxLength: 30 C_ADDR1: type: string maxLength: 100 C_ADDR2: type: string maxLength: 100 C_CTYST: type: string maxLength: 30 C_ZIPCD: type: string maxLength: 10 C_PHONE: type: string maxLength: 15 description: Format '999-999-9999' C_TERRFLAG: type: string maxLength: 30 C_TERR: type: string maxLength: 30 C_STAT: type: string maxLength: 30 C_CONTACT: type: string maxLength: 30 C_PHONE2: type: string maxLength: 15 description: Format '999-999-9999' C_FAX: type: string maxLength: 30 description: Format '999-999-9999' C_TAXID: type: string maxLength: 30 C_SLSID: type: string maxLength: 30 C_EMAIL: type: string maxLength: 100 C_PRICE_LEVEL_DEFAULT: type: string maxLength: 30 C_CUSTTYPE: type: string maxLength: 30 C_PROMPMGMT_CO: type: string maxLength: 30 C_NAME_LONG: type: string maxLength: 100 C_CITY: type: string maxLength: 30 C_STATE: type: string maxLength: 30 C_COUNTRY: type: string maxLength: 100 C_ORDSTATUS: type: string maxLength: 30 required: - COMPANY - C_CID - C_WHSE - C_NAME responses: '200': description: OK content: application/json: schema: type: object properties: RETURN: type: string /{alias}/customersearchbyphone: get: operationId: customerSearch summary: Customer Search tags: - Customer description: Customer Search parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: term in: query required: true schema: type: string maxLength: 30 description: Search term for phone number - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customersearch: get: operationId: customerSearch1 summary: Customer Search tags: - Customer description: Customer Search parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Last edited date. - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Last edited date. - name: term in: query required: true schema: type: string maxLength: 30 description: Search term - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customerproperties: get: operationId: customerProperties summary: Customer Properties tags: - Customer description: Customer Properties parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 30 description: Customer ID responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customerpropertymanagers: get: operationId: customerPropertyManagers summary: Customer Property Managers tags: - Customer description: Customer Property Managers parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customerinvoices: get: operationId: customerInvoices summary: Customer Invoices tags: - Customer description: Customer Invoices List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: false schema: type: string maxLength: 8 - name: type in: query required: false schema: type: string maxLength: 3 description: DEP, ORD, INV, IVA (Returns all invoices within date range, does not use customer ID) - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: search in: query required: false schema: type: string maxLength: 1 description: Optional - "I" searches by invoice date, otherwise register date is used. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customer5year: get: operationId: customer5YearSales summary: Customer 5 Year Sales tags: - Customer description: Customer 5 Year Sales parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 - name: role in: query required: true schema: type: string maxLength: 1 description: Sending S totals sales, R totals open invoice items responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customerARcontacts: get: operationId: customerArContacts summary: Customer AR Contacts tags: - Customer description: Customer AR Contacts parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customercontact: post: operationId: createsCustomerContact summary: Creates Customer Contact tags: - Customer description: Creates Customer Contact parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. customer: type: string maxLength: 8 firstname: type: string maxLength: 30 description: Contact First Name lastname: type: string maxLength: 30 description: Contact Last Name contactrole: type: string maxLength: 30 description: Contact Role phone1: type: string maxLength: 30 description: Contact Phone phone2: type: string maxLength: 30 description: Contact Cell Phone email: type: string maxLength: 100 description: Contact Email text2: type: string maxLength: 1 description: Contact Can Be Texted - Format - 1 For Y, 0 For N. required: - company - customer - firstname - lastname - contactrole - email responses: '200': description: OK content: application/json: schema: type: object properties: ARC_UPDATED: type: string patch: operationId: updatesExistingCustomerContact summary: Updates Existing Customer Contact tags: - Customer description: Update Existing Customer Contact parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 - name: contact in: query required: true schema: type: string maxLength: 6 description: Contact Key - name: sequence in: query required: true schema: type: string maxLength: 3 description: AR contact sequence number - name: firstname in: query required: false schema: type: string maxLength: 30 description: Contact First Name - name: lastname in: query required: false schema: type: string maxLength: 30 description: Contact Last Name - name: contactrole in: query required: false schema: type: string maxLength: 30 description: Contact Role - name: phone1 in: query required: false schema: type: string maxLength: 30 description: Contact Phone - name: phone2 in: query required: false schema: type: string maxLength: 30 description: Contact Cell Phone - name: email in: query required: false schema: type: string maxLength: 100 description: Contact Email - name: text2 in: query required: false schema: type: string maxLength: 1 description: Contact Can Be Texted - Format - 1 For Y, 0 For N. responses: '200': description: OK content: application/json: schema: type: object properties: ARC_UPDATED: type: string /{alias}/customerARnotes: get: operationId: customerArContactNotes summary: Customer AR Contact Notes tags: - Customer description: Customer AR Contact Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: contact in: query required: true schema: type: string maxLength: 6 - name: seq in: query required: false schema: type: string maxLength: 3 requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. required: - company responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/ customerARnotes: post: operationId: createCustomerArContactNotes summary: Create Customer AR Contact Notes tags: - Customer description: Create Customer AR Contact Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. contact: type: string maxLength: 6 seq: type: string maxLength: 3 required: - company responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string patch: operationId: updateCustomerArContactNotes summary: Update Customer AR Contact Notes tags: - Customer description: Update Customer AR Contact Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. contact: type: string maxLength: 6 seq: type: string maxLength: 3 required: - company responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/ ContactNotesbyID: get: operationId: allCustomerContactNotes summary: All Customer Contact Notes tags: - Customer description: All Customer Contact Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: false schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customersaleslist: get: operationId: customerSales summary: Customer Sales tags: - Customer description: Customer Sales List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: false schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/roleList: get: operationId: getContactRoleList summary: Get Contact Role List tags: - Customer description: Get Contact Role List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/shipto: get: operationId: shipToInformation summary: Ship To Information tags: - Customer description: Return Ship To Contact Information parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Required to return valid sale rep contact information. - name: customer in: query required: true schema: type: string maxLength: 8 - name: shipto in: query required: true schema: type: string maxLength: 4 responses: '200': description: OK content: application/json: schema: type: object properties: NAME: type: string ADDR1: type: string ADDR2: type: string CTYST: type: string ZIPCD: type: string PHONE1: type: string PHONE2: type: string FAX: type: string CONTACT: type: string CITY: type: string STATE: type: string TYPE: type: string EMAIL: type: string EMAIL_REP: type: string EMAIL_CUSTOMER: type: string SHIPTO_REP1: type: string SHIPTO_REP1_EMAIL: type: string SHIPTO_REP2: type: string SHIPTO_REP2_EMAIL: type: string SHIPTO_EMAIL_OVERRIDDEN: type: string /{alias}/customershiptos: get: operationId: customerShipToCodes summary: Customer Ship To Codes tags: - Customer description: Gets all customer ship to codes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: custid in: query required: false schema: type: string maxLength: 8 - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/payhist: get: operationId: paymentHistory summary: Payment History tags: - Customer description: Payment History parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 - name: enddate in: query required: true schema: type: string maxLength: 8 - name: customer in: query required: false schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/aropenitem: get: operationId: arOpenItems summary: AR Open Items tags: - Customer description: AR Open Items parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 - name: enddate in: query required: true schema: type: string maxLength: 8 - name: customer in: query required: false schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/shiptocodes: get: operationId: shipToCodeList summary: Ship To Code List tags: - Customer description: Ship To Code List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: When not used, sales rep emails cannot be returned - name: customer in: query required: false schema: type: string maxLength: 8 description: When not used, all customers are returned responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/nationalpropertymanagers: get: operationId: getListOfNationalPropertyManagerRelationships summary: Get list of national property manager relationships tags: - Customer description: Get list of national property manager relationships parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customernotes: post: operationId: createsACustomerNote summary: Creates a Customer Note tags: - Customer description: Creates a Customer Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. customer: type: string maxLength: 8 note: type: string maxLength: 59 required: - company - customer - note responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string patch: operationId: editsACustomerNote summary: Edits a Customer Note tags: - Customer description: Edits a Customer Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 - name: note in: query required: true schema: type: string maxLength: 59 - name: page in: query required: true schema: type: string maxLength: 2 - name: lnnum in: query required: true schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string get: operationId: readsACustomerNote summary: Reads a Customer Note tags: - Customer description: Reads a Customer Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string delete: operationId: erasesACustomerNote summary: Erases a Customer Note tags: - Customer description: Erases a Customer Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 - name: page in: query required: true schema: type: string maxLength: 2 - name: lnnum in: query required: true schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string /{alias}/salesnotes: post: operationId: createsASalesNote summary: Creates a Sales Note tags: - Customer description: Creates a Sales Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. customer: type: string maxLength: 8 custnote: type: string maxLength: 1000 required: - company - customer - custnote responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_NOTE: type: string USER_ID: type: string DATE: type: string TIME: type: string patch: operationId: editsASalesNote summary: Edits a Sales Note tags: - Customer description: Edits a Sales Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 - name: custnote in: query required: true schema: type: string maxLength: 1000 responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_NOTE: type: string USER_ID: type: string DATE: type: string TIME: type: string get: operationId: readsASalesNote summary: Reads a Sales Note tags: - Customer description: Reads a Sales Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_NOTE: type: string USER_ID: type: string DATE: type: string TIME: type: string delete: operationId: erasesASalesNote summary: Erases a Sales Note tags: - Customer description: Erases a Sales Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_NOTE: type: string USER_ID: type: string DATE: type: string TIME: type: string /{alias}/shiptonotes: post: operationId: createsACustomerNoteByShiptoCodeInactiveUntil2102Release summary: Creates a Customer Note by ShipTo Code - Inactive until 2102 Release tags: - Customer description: Creates a Customer Note by ShipTo Code - Inactive until 2102 Release parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. customer: type: string maxLength: 8 note: type: string maxLength: 59 shipto: type: string maxLength: 4 required: - company - customer - note - shipto responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string patch: operationId: updatesACustomerNoteByShiptoCodeInactiveUntil2102Release summary: Updates a Customer Note by ShipTo Code - Inactive until 2102 Release tags: - Customer description: Updates a Customer Note by ShipTo Code - Inactive until 2102 Release parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 - name: note in: query required: true schema: type: string maxLength: 59 - name: page in: query required: true schema: type: string maxLength: 2 - name: lnnum in: query required: true schema: type: string maxLength: 3 requestBody: required: true content: application/json: schema: type: object properties: shipto: type: string maxLength: 4 required: - shipto responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string get: operationId: getsAllCustomerNoteByShiptoCodeInactiveUntil2102Release summary: Gets all Customer Note by ShipTo Code - Inactive until 2102 Release tags: - Customer description: Gets all Customer Note by ShipTo Code - Inactive until 2102 Release parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 requestBody: required: true content: application/json: schema: type: object properties: shipto: type: string maxLength: 4 required: - shipto responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string delete: operationId: erasesACustomerNoteByShiptoCodeInactiveUntil2102Release summary: Erases a Customer Note by ShipTo Code - Inactive until 2102 Release tags: - Customer description: Erases a ShipTo Note - Inactive until 2102 Release parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: true schema: type: string maxLength: 8 - name: page in: query required: true schema: type: string maxLength: 2 - name: lnnum in: query required: true schema: type: string maxLength: 3 requestBody: required: true content: application/json: schema: type: object properties: shipto: type: string maxLength: 4 required: - shipto responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string CUSTOMER_ID: type: string CUSTOMER_ADDRESS: type: string PAGE: type: string LINE: type: string NOTE: type: string /{alias}/customersearchbyemail: get: operationId: customerSearch2 summary: Customer Search tags: - Customer description: Customer Search parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: terms in: query required: true schema: type: string maxLength: 30 description: Search term for email address - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customercreditstats: get: operationId: getListOfPossibleCustomerCreditStatusCodes summary: Get List of possible customer credit status codes tags: - Customer description: Get List of possible customer credit status codes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/company: get: operationId: companyInfo summary: Company Info tags: - Company description: Get company info parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: ID: type: string NAME: type: string /{alias}/branch: get: operationId: branchInfo summary: Branch info tags: - Company description: Get branch info parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. responses: '200': description: OK content: application/json: schema: type: object properties: ID: type: string NAME: type: string ADDRESS1: type: string ADDRESS2: type: string CITYSTATE: type: string ZIPCD: type: string TELEPHONE1: type: string TELEPHONE2: type: string CITY: type: string STATE: type: string COUNTRY: type: string EMAIL: type: string /{alias}/branches: get: operationId: branchesList summary: Branches list tags: - Company description: Get branches info parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/systeminfo: get: operationId: systemInformation summary: System Information tags: - Company description: Return various configuration, system, company, and branch settings parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. responses: '200': description: OK content: application/json: schema: type: object properties: Configuration: type: object Companies: type: array items: type: array items: type: string /{alias}/globalsettings: get: operationId: globalSettings summary: Global settings tags: - Company description: Settings list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/companysettings: get: operationId: settingsSpecificToACompany summary: Settings specific to a company tags: - Company description: Settings list for specific company objects parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/territorycodes: get: operationId: territoryCodesList summary: Territory Codes List tags: - Company description: Territory Codes List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/producttypes: get: operationId: productTypes summary: Product types tags: - Product description: Product types list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/productcodes: get: operationId: productCodes summary: Product codes tags: - Product description: Product codes list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodtype in: query required: false schema: type: string maxLength: 6 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/productstyles: get: operationId: productStyles summary: Product styles tags: - Product description: Product styles list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodcode in: query required: true schema: type: string maxLength: 2 - name: prodtype in: query required: false schema: type: string maxLength: 6 description: Optional product type to narrow results responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/productstylessearch: get: operationId: productStyles1 summary: Product styles tags: - Product description: Product styles list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: catstatus in: query required: false schema: type: string maxLength: 1 description: Optional status to narrow results - can be Y or N. - name: prodcode in: query required: false schema: type: string maxLength: 2 description: Optional product code to narrow results - name: prodtype in: query required: false schema: type: string maxLength: 6 description: Optional product type to narrow results - name: term in: query required: false schema: type: string maxLength: 80 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 in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/productcolors: get: operationId: productColors summary: Product colors tags: - Product description: Product colors list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodcode in: query required: true schema: type: string maxLength: 2 - name: prodstyle in: query required: true schema: type: string maxLength: 80 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 in: query required: false schema: type: string maxLength: 13 description: Catseq is not required .If all fields provided, only catseq is used. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/productstock: get: operationId: productStock summary: Product stock tags: - Product description: Product stock list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: true schema: type: string maxLength: 14 description: Barcode or Catseq required. - name: catseq in: query required: true schema: type: string maxLength: 13 description: Barcode or Catseq required. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/productprice: get: operationId: productPrice summary: Product price tags: - Product description: Product price parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch specific pricing when applicable. - name: barcode in: query required: true schema: type: string maxLength: 14 - name: catseq in: query required: true schema: type: string maxLength: 13 description: Barcode or Catseq required to return stock. If both are provided, only catseq is used. - name: customer in: query required: false schema: type: string maxLength: 8 description: Optional, gets customer/property mgr specific special pricing when applicable. - name: customertype in: query required: false schema: type: string maxLength: 8 description: Optional, gets customer type specific special pricing when applicable. - name: shipto in: query required: false schema: type: string maxLength: 4 description: Optional, gets property mgr specific special pricing when applicable, customer is required when using shipto. responses: '200': description: OK content: application/json: schema: type: object properties: BARCODE: type: string BRANCH: type: string PRODCODE: type: string STYLE: type: string STYLENUM: type: string COLOR: type: string COLORNUM: type: string BYBOX: type: string UNITPERBOX: type: string PRICEANAME: type: string PRICEAC: type: string PRICEAR: type: string PRICEBNAME: type: string PRICEBC: type: string PRICEBR: type: string PRICECNAME: type: string PRICECC: type: string PRICECR: type: string PRICEDNAME: type: string PRICEDC: type: string PRICEDR: type: string PRICEENAME: type: string PRICEEC: type: string PRICEER: type: string PRICEFNAME: type: string PRICEFC: type: string PRICEFR: type: string PRICEGNAME: type: string PRICEGC: type: string PRICEGR: type: string PRICEHNAME: type: string PRICEHC: type: string PRICEHR: type: string PRICEINAME: type: string PRICEIC: type: string PRICEIR: type: string PRICEJNAME: type: string PRICEJC: type: string PRICEJR: type: string SPECIALPRICEC: type: string SPECIALPRICER: type: string FLOAT_UNITPERBOX: type: string FLOAT_PRICENAMEA: type: string FLOAT_PRICEAC: type: string FLOAT_PRICEAR: type: string FLOAT_PRICENAMEB: type: string FLOAT_PRICEBC: type: string FLOAT_PRICEBR: type: string FLOAT_PRICENAMEC: type: string FLOAT_PRICECC: type: string FLOAT_PRICECR: type: string FLOAT_PRICENAMED: type: string FLOAT_PRICEDC: type: string FLOAT_PRICEDR: type: string FLOAT_PRICENAMEE: type: string FLOAT_PRICEEC: type: string FLOAT_PRICEER: type: string FLOAT_PRICENAMEF: type: string FLOAT_PRICEFC: type: string FLOAT_PRICEFR: type: string FLOAT_PRICENAMEG: type: string FLOAT_PRICEGC: type: string FLOAT_PRICEGR: type: string FLOAT_PRICENAMEH: type: string FLOAT_PRICEHC: type: string FLOAT_PRICEHR: type: string FLOAT_PRICENAMEI: type: string FLOAT_PRICEIC: type: string FLOAT_PRICEIR: type: string FLOAT_PRICENAMEJ: type: string FLOAT_PRICEJC: type: string FLOAT_PRICEJR: type: string FLOAT_SPECIALPRICEC: type: string FLOAT_SPECIALPRICER: type: string UOM: type: string WIDTH: type: string SIMPLE_TAXABLE: type: string /{alias}/catalogattributes: get: operationId: productAttributes summary: Product Attributes tags: - Product description: Product Attributes for Catalog Sequence parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: catseq in: query required: true schema: type: string maxLength: 13 responses: '200': description: OK content: application/json: schema: type: object properties: CATR1_WEBNAME: type: string CATR1_SHOWWEB: type: string CATR1_INTEGER_1: type: string CATR1_INTEGER_2: type: string CATR1_INTEGER_3: type: string CATR1_INTEGER_4: type: string CATR1_NUM3DEC_1: type: string CATR1_NUM3DEC_2: type: string CATR1_NUM3DEC_3: type: string CATR1_NUM3DEC_4: type: string CATR1_NUM3DEC_5: type: string CATR1_NUM3DEC_6: type: string CATR1_NUM3DEC_7: type: string CATR1_NUM3DEC_8: type: string CATR1_NUM3DEC_9: type: string CATR1_NUM3DEC_10: type: string CATR1_NUM3DEC_11: type: string CATR1_NUM3DEC_12: type: string CATR1_NUM3DEC_13: type: string CATR1_NUM3DEC_14: type: string CATR1_NOTE_SHORT: type: string CATR1_NOTE_LONG: type: string CATR1_BULLET_POINT1: type: string CATR1_BULLET_POINT2: type: string CATR1_BULLET_POINT3: type: string CATR1_BULLET_POINT4: type: string CATR1_BULLET_POINT5: type: string CATR1_BULLET_POINT6: type: string CATR1_BULLET_POINT7: type: string CATR1_BULLET_POINT8: type: string CATR1_BULLET_POINT9: type: string CATR1_BULLET_POINT10: type: string CATR2_DROPLIST_1: type: string CATR2_DROPLIST_2: type: string CATR2_DROPLIST_3: type: string CATR2_DROPLIST_4: type: string CATR2_DROPLIST_5: type: string CATR2_DROPLIST_6: type: string CATR2_DROPLIST_7: type: string CATR2_DROPLIST_8: type: string CATR2_DROPLIST_9: type: string CATR2_DROPLIST_10: type: string CATR2_DROPLIST_11: type: string CATR2_DROPLIST_12: type: string CATR2_DROPLIST_13: type: string CATR2_DROPLIST_14: type: string CATR2_DROPLIST_15: type: string CATR2_DROPLIST_16: type: string CATR2_DROPLIST_17: type: string CATR2_DROPLIST_18: type: string CATR2_DROPLIST_19: type: string CATR2_DROPLIST_20: type: string CATR2_DROPLIST_21: type: string CATR2_DROPLIST_22: type: string CATR2_DROPLIST_23: type: string CATR2_DROPLIST_24: type: string CATR2_DROPLIST_25: type: string CATR2_DROPLIST_26: type: string CATR2_DROPLIST_27: type: string CATR2_DROPLIST_28: type: string CATR2_DROPLIST_29: type: string CATR2_DROPLIST_30: type: string CATR2_DROPLIST_31: type: string CATR2_DROPLIST_32: type: string CATR2_DROPLIST_33: type: string CATR2_DROPLIST_34: type: string CATR2_DROPLIST_35: type: string CATR2_DROPLIST_36: type: string CATR2_DROPLIST_37: type: string CATR2_DROPLIST_38: type: string CATR2_DROPLIST_39: type: string CATR2_DROPLIST_40: type: string MULTIPICKS: type: array items: type: array items: type: string CATR2_CUSTOM_1: type: string CATR2_CUSTOM_2: type: string CATR2_CUSTOM_3: type: string CATR2_CUSTOM_4: type: string CATR2_CUSTOM_5: type: string CATR2_CUSTOM_6: type: string CATR2_CUSTOM_7: type: string CATR2_CUSTOM_8: type: string CATR2_CUSTOM_9: type: string CATR2_CUSTOM_10: type: string CATR2_CUSTOM_11: type: string CATR2_CUSTOM_12: type: string CATR2_CUSTOM_13: type: string /{alias}/attributelabels: get: operationId: attributesLabels summary: Attributes Labels tags: - Product description: Attributes Labels parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodtype in: query required: true schema: type: string maxLength: 6 responses: '200': description: OK content: application/json: schema: type: object properties: CATRD_FIELD_NAME_1: type: string CATRD_FIELD_NAME_2: type: string CATRD_FIELD_NAME_3: type: string CATRD_FIELD_NAME_4: type: string CATRD_FIELD_NAME_5: type: string CATRD_FIELD_NAME_6: type: string CATRD_FIELD_NAME_7: type: string CATRD_FIELD_NAME_8: type: string CATRD_FIELD_NAME_9: type: string CATRD_FIELD_NAME_10: type: string CATRD_FIELD_NAME_11: type: string CATRD_FIELD_NAME_12: type: string CATRD_FIELD_NAME_13: type: string CATRD_FIELD_NAME_14: type: string CATRD_FIELD_NAME_15: type: string CATRD_FIELD_NAME_16: type: string CATRD_FIELD_NAME_17: type: string CATRD_FIELD_NAME_18: type: string CATRD_FIELD_NAME_19: type: string CATRD_FIELD_NAME_20: type: string CATRD_FIELD_NAME_21: type: string CATRD_FIELD_NAME_22: type: string CATRD_FIELD_NAME_23: type: string CATRD_FIELD_NAME_24: type: string CATRD_FIELD_NAME_25: type: string CATRD_FIELD_NAME_26: type: string CATRD_FIELD_NAME_27: type: string CATRD_FIELD_NAME_28: type: string CATRD_FIELD_NAME_29: type: string CATRD_FIELD_NAME_30: type: string CATRD_FIELD_NAME_31: type: string CATRD_FIELD_NAME_32: type: string CATRD_FIELD_NAME_33: type: string CATRD_FIELD_NAME_34: type: string CATRD_FIELD_NAME_35: type: string CATRD_FIELD_NAME_36: type: string CATRD_FIELD_NAME_37: type: string CATRD_FIELD_NAME_38: type: string CATRD_FIELD_NAME_39: type: string CATRD_FIELD_NAME_40: type: string CATRD_FIELD_NAME_41: type: string CATRD_FIELD_NAME_42: type: string CATRD_FIELD_NAME_43: type: string CATRD_FIELD_NAME_44: type: string CATRD_FIELD_NAME_45: type: string CATRD_FIELD_NAME_46: type: string CATRD_FIELD_NAME_47: type: string CATRD_FIELD_NAME_48: type: string CATRD_FIELD_NAME_49: type: string CATRD_FIELD_NAME_50: type: string CATRD_FIELD_NAME_51: type: string CATRD_FIELD_NAME_52: type: string CATRD_FIELD_NAME_53: type: string CATRD_FIELD_NAME_54: type: string CATRD_FIELD_NAME_55: type: string CATRD_FIELD_NAME_56: type: string CATRD_FIELD_NAME_57: type: string CATRD_FIELD_NAME_58: type: string CATRD_FIELD_NAME_59: type: string CATRD_FIELD_NAME_60: type: string CATRD_FIELD_NAME_61: type: string CATRD_FIELD_NAME_62: type: string CATRD_FIELD_NAME_63: type: string CATRD_FIELD_NAME_64: type: string CATRD_FIELD_NAME_65: type: string CATRD_FIELD_NAME_66: type: string CATRD_FIELD_NAME_67: type: string CATRD_FIELD_NAME_68: type: string CATRD_FIELD_NAME_69: type: string CATRD_FIELD_NAME_70: type: string CATRD_FIELD_NAME_71: type: string CATRD_FIELD_NAME_72: type: string CATRD_FIELD_NAME_73: type: string CATRD_FIELD_NAME_74: type: string CATRD_FIELD_NAME_75: type: string CATRD_FIELD_NAME_76: type: string CATRD_FIELD_NAME_77: type: string CATRD_FIELD_NAME_78: type: string CATRD_FIELD_NAME_79: type: string CATRD_FIELD_NAME_80: type: string CATRD_FIELD_NAME_81: type: string CATRD_FIELD_NAME_82: type: string CATRD_FIELD_NAME_83: type: string CATRD_FIELD_NAME_84: type: string CATRD_FIELD_NAME_85: type: string CATRD_FIELD_NAME_86: type: string CATRD_FIELD_NAME_87: type: string CATRD_FIELD_NAME_88: type: string CATRD_FIELD_NAME_89: type: string CATRD_FIELD_NAME_90: type: string CATRD_FIELD_NAME_91: type: string CATRD_FIELD_NAME_92: type: string CATRD_FIELD_NAME_93: type: string CATRD_FIELD_NAME_94: type: string CATRD_FIELD_NAME_95: type: string CATRD_FIELD_NAME_96: type: string CATRD_FIELD_NAME_97: type: string CATRD_FIELD_NAME_98: type: string CATRD_FIELD_NAME_99: type: string CATRD_FIELD_NAME_100: type: string CATRD_FIELD_NAME_101: type: string CATRD_FIELD_NAME_102: type: string CATRD_FIELD_NAME_103: type: string CATRD_FIELD_NAME_104: type: string CATRD_FIELD_NAME_105: type: string CATRD_FIELD_NAME_106: type: string CATRD_FIELD_NAME_107: type: string CATRD_FIELD_NAME_108: type: string CATRD_FIELD_NAME_109: type: string CATRD_FIELD_NAME_110: type: string CATRD_FIELD_NAME_111: type: string CATRD_FIELD_NAME_112: type: string CATRD_FIELD_NAME_113: type: string CATRD_FIELD_NAME_114: type: string CATRD_FIELD_NAME_115: type: string CATRD_FIELD_NAME_116: type: string CATRD_FIELD_NAME_117: type: string CATRD_FIELD_NAME_118: type: string CATRD_FIELD_NAME_119: type: string CATRD_FIELD_NAME_120: type: string CATRD_FIELD_NAME_121: type: string CATRD_FIELD_NAME_122: type: string CATRD_FIELD_NAME_123: type: string CATRD_FIELD_NAME_124: type: string CATRD_FIELD_NAME_125: type: string CATRD_FIELD_NAME_126: type: string CATRD_FIELD_NAME_127: type: string CATRD_FIELD_NAME_128: type: string CATRD_FIELD_NAME_129: type: string CATRD_FIELD_NAME_130: type: string CATRD_FIELD_NAME_131: type: string CATRD_FIELD_NAME_132: type: string CATRD_FIELD_NAME_133: type: string CATRD_FIELD_NAME_134: type: string CATRD_FIELD_NAME_135: type: string CATRD_FIELD_NAME_136: type: string CATRD_FIELD_NAME_137: type: string CATRD_FIELD_NAME_138: type: string CATRD_FIELD_NAME_139: type: string CATRD_FIELD_NAME_140: type: string CATRD_FIELD_NAME_141: type: string CATRD_FIELD_NAME_142: type: string CATRD_FIELD_NAME_143: type: string CATRD_FIELD_NAME_144: type: string CATRD_FIELD_NAME_145: type: string CATRD_FIELD_NAME_146: type: string CATRD_FIELD_NAME_147: type: string CATRD_FIELD_NAME_148: type: string CATRD_FIELD_NAME_149: type: string CATRD_FIELD_NAME_150: type: string /{alias}/webproducts: get: operationId: webProducts summary: Web Products tags: - Product description: Web Products parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' 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 in: query required: false schema: type: string maxLength: 1 description: 1 returns active web products - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks for last catalog record update date. - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks for last catalog record update date. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/catalogdetails: get: operationId: productDetails summary: Product details tags: - Product description: Product details parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: false schema: type: string maxLength: 14 - name: catseq in: query required: false schema: type: string maxLength: 13 description: Barcode or Catseq required. responses: '200': description: OK content: application/json: schema: type: object properties: CAT_SEQUENCE: type: string CAT_PRODUCT_ID: type: string CAT_PRODCODE: type: string CAT_STYLE: type: string CAT_STYNUM: type: string CAT_COLOR: type: string CAT_COLNUM: type: string CAT_ITEMDESC: type: string CAT_VENDORID: type: string CAT_VENDSTYLE: type: string CAT_VENDCOLOR: type: string CAT_VENDSTYNUM: type: string CAT_VENDCOLNUM: type: string CAT_MANUFACT: type: string CAT_SERIALNUMBER: type: string CAT_URL: type: string CAT_YARNTYP: type: string CAT_USERDEFINED1: type: string CAT_USERDEFINED2: type: string CAT_USERDEFINED3: type: string CAT_USERDEFINED4: type: string CAT_USERID: type: string CAT_BYBOX: type: string CAT_UNIT_PER_BOX: type: string CAT_STOCK: type: string CAT_WIDTH: type: string CAT_BACKING: type: string CAT_FIBER: type: string CAT_WEIGHT: type: string CAT_WEIGHT_TYPE: type: string CAT_PATTERNMATCH: type: string CAT_SAMPLE: type: string CAT_SAMPLE_SIZE: type: string CAT_ORDER_PO: type: string CAT_UNITCOST: type: string CAT_FREIGHT: type: string CAT_ROLL_COST: type: string CAT_COVERBILL: type: string CAT_LAST_PRICE_SALE: type: string CAT_BOM: type: string CAT_DIM_LENGTH: type: string CAT_DIM_WIDTH: type: string CAT_NO_RETURNS: type: string CAT_CONSIGNMENT: type: string CAT_PROGRAMMED: type: string CAT_PROMO_QTY_REQUIRED: type: string CAT_PROMO_QTY_COST: type: string CAT_PROMO_UNIT_COST: type: string CAT_PROMO_ROLL_COST: type: string CAT_PROMO_START_DATE: type: string CAT_PROMO_END_DATE: type: string CAT_LAST_PRICE_QTY: type: string CAT_LPR_RC_PRICE: type: string CAT_LAST_PRICE_RL: type: string CAT_LAST_PRICE_ROLL: type: string CAT_LAST_PRICE_COST: type: string CAT_LASTPRICE: type: string CAT_LASTRC: type: string CAT_PRICE_CHG_DATE: type: string CAT_LABOR_OVERBILL_UOM: type: string CAT_B2B_SKU: type: string CAT_MAP_PRICE_REQUIRED: type: string CAT_MAP_PRICE: type: string CAT_UOM: type: string CAT_CROSSREF: type: string /{alias}/associatedproducts: get: operationId: getAssociatedProducts summary: Get Associated Products tags: - Product description: Associated Products List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: catseq in: query required: false schema: type: string maxLength: 13 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/catalogitems: get: operationId: catalogItems summary: Catalog Items tags: - Product description: Gets all catalog items parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' 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 in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: lastdays in: query required: false schema: type: string maxLength: 4 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. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/getcatatrcollection: get: operationId: getCatalogAttributeCollections summary: Get Catalog Attribute Collections tags: - Product description: Get Catalog Attribute Collections parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodtype in: query required: false schema: type: string maxLength: 6 description: Optional - returns collection by product type responses: '200': description: OK content: application/json: schema: type: object properties: CATRCL_KEY: type: string CATRCL_CODIV: type: string CATRCL_PCTYPE: type: string CATRCL_BRAND: type: string CATRCL_COLLECTION: type: string /{alias}/getcatatrbrands: get: operationId: getCatalogAttributeBrands summary: Get Catalog Attribute Brands tags: - Product description: Get Catalog Attribute Brands parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodtype in: query required: false schema: type: string maxLength: 6 description: Optional - returns brands by product type responses: '200': description: OK content: application/json: schema: type: object properties: CATRBR_KEY: type: string CATRBR_CODIV: type: string CATRBR_PCTYPE: type: string CATRBR_BRAND: type: string CATRBR_COLLECTION: type: string /{alias}/getcatatrsalesrep: get: operationId: getCatalogAttributeSalesRep summary: Get Catalog Attribute Sales Rep tags: - Product description: Get Catalog Attribute Sales Rep parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch-specific info when applicable - name: catseq in: query required: false schema: type: string maxLength: 13 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CATRREP_KEY: type: string CATRREP_CODIV: type: string CATRREP_WHSE: type: string CATRREP_SEQUENCE: type: string CATRREP_SLSREP: type: string /{alias}/getcatatrinventory: get: operationId: getCatalogAttributeInventoryTypes summary: Get Catalog Attribute Inventory Types tags: - Product description: Get Catalog Attribute Inventory Types parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch-specific info when applicable - name: catseq in: query required: false schema: type: string maxLength: 13 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CATRINV_KEY: type: string CATRINV_CODIV: type: string CATRINV_WHSE: type: string CATRINV_SEQUENCE: type: string CATRINV_TYPE_1: type: string CATRINV_TYPE_2: type: string /{alias}/getcatatrcustomer: get: operationId: getCatalogAttributeCustomer summary: Get Catalog Attribute Customer tags: - Product description: Get Catalog Attribute Customers parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch-specific info when applicable - name: catseq in: query required: false schema: type: string maxLength: 13 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CATRCUST_KEY: type: string CATRCUST_CODIV: type: string CATRCUST_WHSE: type: string CATRCUST_SEQUENCE: type: string CATRCUST_CUSTOMER: type: string /{alias}/getcatatrdate: get: operationId: getCatalogAttributeDates summary: Get Catalog Attribute Dates tags: - Product description: Get Catalog Attribute Dates parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch-specific info when applicable - name: catseq in: query required: false schema: type: string maxLength: 13 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CATRDT_KEY: type: string CATRDT_CODIV: type: string CATRDT_WHSE: type: string CATRDT_SEQUENCE: type: string CATRDT_DATE_1: type: string CATRDT_DATE_2: type: string CATRDT_DATE_3: type: string CATRDT_DATE_4: type: string CATRDT_DATE_5: type: string CATRDT_BRAND: type: string CATRDT_COLLECTION: type: string /{alias}/getcatatrselinv: get: operationId: getSelectedInventoryCatalogAttribute summary: Get Selected Inventory Catalog Attribute tags: - Product description: Get Selected Inventory Catalog Attribute parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodtype in: query required: false schema: type: string maxLength: 6 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CATRSINV_KEY: type: string CATRSINV_CODIV: type: string CATRSINV_PCTYPE: type: string CATRSINV_FIELD: type: string CATRSINV_SEQ: type: string CATRSINV_VALUE: type: string CATRSINV_USER: type: string CATRSINV_DATE: type: string CATRSINV_TIME: type: string /{alias}/getcatatrsel2: get: operationId: getSelectedCatalogAttributeFile2 summary: Get Selected Catalog Attribute File 2 tags: - Product description: Get Selected Catalog Attribute File 2 parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodtype in: query required: false schema: type: string maxLength: 6 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CATRS2_KEY: type: string CATRS2_CODIV: type: string CATRS2_PCTYPE: type: string CATRS2_FIELD: type: string CATRS2V_SEQ: type: string CATRS2_VALUE: type: string CATRS2_USER: type: string CATRS2_DATE: type: string CATRS2_TIME: type: string /{alias}/getcatatrsel3: get: operationId: getSelectedCatalogAttributeFile3 summary: Get Selected Catalog Attribute File 3 tags: - Product description: Get Selected Catalog Attribute File 3 parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: prodtype in: query required: false schema: type: string maxLength: 6 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CATRS3_KEY: type: string CATRS3_CODIV: type: string CATRS3_PCTYPE: type: string CATRS3_FIELD: type: string CATRS23_SEQ: type: string CATRS3_VALUE: type: string CATRS3_USER: type: string CATRS3_DATE: type: string CATRS3_TIME: type: string /{alias}/productpagedetails: get: operationId: samplePricingData summary: Sample Pricing Data tags: - Retail Pricing description: Grabs necessary data from QR code for sample pricing fields parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: catseq in: query required: true schema: type: string description: Catalog ID for product responses: '200': description: OK content: application/json: schema: type: object properties: LOGO: type: string NAME: type: string STYLE: type: string STYNUM: type: string COLOR: type: string COLORNUM: type: string UNITPERBOX: type: string PRICE: type: string /{alias}/edocs: get: operationId: edocsList summary: Edocs List tags: - Edocs description: Get edocs for object record parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: edoctype in: query required: true schema: type: string default: order enum: - order - lead - property - po - quote - vendor - customer - apinvoice - name: order in: query required: true schema: type: string description: required when edoctype is 'order' - name: leadno in: query required: false schema: type: string description: required when edoctype is 'lead' - name: po in: query required: false schema: type: string description: required when edoctype is 'po' - name: quote in: query required: false schema: type: string description: required when edoctype is 'quote' - name: customer in: query required: false schema: type: string description: required when edoctype is 'property' or 'customer' - name: shcode in: query required: false schema: type: string description: required when edoctype is 'property' - name: property in: query required: false schema: type: string description: required when edoctype = 'property' - name: vendor in: query required: false schema: type: string description: required when edoctype is 'vendor' or 'apinvoice' - name: refnum in: query required: false schema: type: string description: required when edoctype is 'apinvoice' - name: aptype in: query required: false schema: type: string description: required when edoctype is 'apinvoice' responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/edoc: post: operationId: edocUpload summary: Edoc upload tags: - Edocs description: Upload edoc parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. edoctype: type: string default: order enum: - order - catalog - lead - po - quote - vendor - customer - apinvoice desc: type: string file_data: type: string description: Pass the base64 string of the file. file_name: type: string edocategory: type: string description: "Series of 'Y' or 'N' corresponding to category index(es) that the document should appear under.\n\ \nCategory names by index:\n 1.\t General\n 2.\t Diagrams\n 3.\t Invoices\n 4.\t Legal\n 5.\t Claims\n\ \ 6.\t User Defined\n 7.\t User Defined\n 8.\t User Defined\n 9.\t User Defined\n 10. User Defined\n\ \ 11. User Defined\n 12. User Defined\n 13. User Defined\n 14. User Defined\n 15. User Defined" order: type: string description: Required for edoctype 'order' catseq: type: string description: Required for edoctype 'catalog' leadno: type: string description: Required for edoctype 'lead' pono: type: string description: Required for edoctype 'po' quote: type: string description: Required for edoctype 'quote' vendor: type: string description: Required for edoctype 'vendor' or 'apinvoice' customer: type: string description: Required for edoctype 'customer' refnum: type: string description: Required for edoctype 'apinvoice' aptype: type: string description: Required for edoctype 'apinvoice' required: - company - branch - edoctype - file_data - file_name - edocategory responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string ORDER: type: string SEQ: type: string CATSEQUENCE: type: string PRODCODE: type: string PRODUCTID: type: string DATE: type: string TIME: type: string get: operationId: edocDownload summary: Edoc download tags: - Edocs description: Get edoc download parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: edoctype in: query required: true schema: type: string default: order enum: - order - lead - property - po - quote - vendor - customer - apinvoice - name: order in: query required: false schema: type: string description: required when edoctype is 'order' - name: leadno in: query required: false schema: type: string description: required when edoctype is 'lead' - name: po in: query required: false schema: type: string description: required when edoctype is 'po' - name: quote in: query required: false schema: type: string description: required when edoctype is 'quote' - name: seq in: query required: true schema: type: string - name: customer in: query required: false schema: type: string description: required when edoctype is 'property' or 'customer' - name: shcode in: query required: false schema: type: string description: required when edoctype is 'property' - name: property in: query required: false schema: type: string description: required when edoctype = 'property' - name: vendor in: query required: false schema: type: string description: required when edoctype is 'vendor' or 'apinvoice' - name: refnum in: query required: false schema: type: string description: required when edoctype is 'apinvoice' - name: aptype in: query required: false schema: type: string description: required when edoctype is 'apinvoice' responses: '200': description: OK /{alias}/edoctypes: get: operationId: getEdocTypesForUser summary: Get Edoc types for user tags: - Edocs description: Get Edoc types for user parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/installers: get: operationId: installersList summary: Installers list tags: - Install description: Installers list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/installer: get: operationId: installerInfo summary: Installer info tags: - Install description: Installer info parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: installer in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: INS_CODE: type: string INS_NAME: type: string INS_WHSE: type: string INS_ADDR1: type: string INS_ADDR2: type: string INS_CTYST: type: string INS_ZIPCD: type: string INS_TELE1: type: string INS_TELE2: type: string INS_PAYTYP: type: string INS_SPECIALTY: type: string INS2_INACTIVE: type: string INS_CITY: type: string INS_STATE: type: string INS_EMAIL: type: string INS_MAX_INSTALL: type: string INS_NOTE: type: string INS_RESTRICTIONS: type: array items: type: array items: type: array items: type: string /{alias}/installerlist: get: operationId: installerList summary: Installer List tags: - Install description: Installer List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/installdetail: get: operationId: installListByDate summary: Install List by date tags: - Install description: Order Time Slot List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: job in: query required: true schema: type: string maxLength: 6 description: Job (order) number - name: lnnum in: query required: true schema: type: string maxLength: 3 description: Line number. Send as 'X' if returning multi-date records. - name: instime in: query required: true schema: type: string maxLength: 8 description: Install time code. Send as 'X' if returning multi-date records. - name: insdate in: query required: true schema: type: string maxLength: 8 description: Install date. Send as 'X' if returning multi-date records. - name: insseq in: query required: true schema: type: string maxLength: 4 description: Install line sequence. Send as 'X' if returning multi-date records. - name: installer in: query required: true schema: type: string maxLength: 8 description: Installer ID. Send as 'X' if returning multi-date records. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: array items: type: array items: type: string /{alias}/installerinvoice: get: operationId: generateInstallerInvoicePdf summary: Generate Installer Invoice PDF tags: - Install description: Generate Installer Invoice PDF parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: true schema: type: string maxLength: 6 description: Job (order) number - name: gst in: query required: false schema: type: string description: GST input, expecting .99 format (percentile) - name: invoicenumber in: query required: false schema: type: string maxLength: 20 - name: invoicehours in: query required: false schema: type: string maxLength: 7 description: Format of 999.999 expected - name: note in: query required: false schema: type: string maxLength: 250 responses: '200': description: OK content: application/json: schema: type: object properties: RETURNED_PDF: type: string /{alias}/getinstallations: get: operationId: installationsByDate summary: Installations By Date tags: - Install description: Get Installations By Date Range parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: beginning in: query required: false schema: type: string maxLength: 1 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 in: query required: false schema: type: array items: type: string 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 in: query required: false schema: type: array items: type: string 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 in: query required: false schema: type: array items: type: string description: CSV list of accum codes. See [accumcode](#/Order/get_accumcode) endpoint for more info. - name: installers in: query required: false schema: type: array items: type: string 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 in: query required: false schema: type: array items: type: string 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 in: query required: false schema: type: string 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 in: query required: false schema: type: string default: both enum: - open - closed - both - name: shunit in: query required: false schema: type: string maxLength: 6 description: Used to search by job unit, must be exact match. - name: barcode in: query required: false schema: type: string maxLength: 14 description: Catalog barcode to search by style & color. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/install: post: operationId: createInstallationRecord summary: Create Installation Record tags: - Install description: Creates Installation Records. Returns the record. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. job: type: string maxLength: 6 jobline: type: string maxLength: 3 startdate: type: string maxLength: 8 description: Format - YYYYMMDD enddate: type: string maxLength: 8 description: Format - YYYYMMDD installer: type: string maxLength: 8 quantity: type: string maxLength: 15 description: Quantity to assign or all. required: - company - branch - job - jobline - startdate - enddate responses: '200': description: OK content: application/json: schema: type: object properties: DMOID_CODIV: type: string DMOID_WHSE: type: string DMOID_ORDNO: type: string DMOID_SEQ: type: string DMOID_LNNUM: type: string DMOID_LABOR_CODE: type: string DMOID_WQTY: type: string DMOID_INSTALLER: type: string DMOID_NAME: type: string DMOID_INSDATE: type: string DMOID_TIME: type: string DMOID_O_A_D: type: string DMOID_SUBMITTED: type: string /{alias}/installs: get: operationId: getInstallationRecords summary: Get Installation Records tags: - Install description: Get Installation Records parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: true schema: type: string maxLength: 6 - name: jobline in: query required: false schema: type: string maxLength: 3 - name: insseq in: query required: false schema: type: string maxLength: 3 description: Will use insseq instead of jobline when not empty. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/installcapacity: get: operationId: installationLimitsAndCapacities summary: Installation limits and capacities tags: - Install description: Installation scheduling limits and capacities parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: array items: type: array items: type: string /{alias}/dashboardsales: get: operationId: salesQuicklist summary: Sales Quicklist tags: - Dashboard description: Sales quicklist by month over date range parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: customer in: query required: false schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/dashboardar: get: operationId: arQuicklist summary: AR Quicklist tags: - Dashboard description: Quicklist for AR buckets parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: false schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/dashboardap: get: operationId: apQuicklist summary: AP Quicklist tags: - Dashboard description: Quicklist for AP buckets parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/dashboardinventory: get: operationId: inventoryValuationQuicklist summary: Inventory Valuation Quicklist tags: - Dashboard description: Inventory Valuation Quicklist parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/dashboardworkinprocess: get: operationId: workInProcessQuicklist summary: Work in Process quicklist tags: - Dashboard description: Work in Process quicklist parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: customer in: query required: false schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/dashboardfiscal: get: operationId: fiscalYearQuicklist summary: Fiscal Year Quicklist tags: - Dashboard description: Fiscal year sales by period parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/accountspayablebuckets: get: operationId: apBucketDefinitions summary: AP Bucket Definitions tags: - Pivot description: Bucket definitions for AP parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/accountspayable: get: operationId: apByBucket summary: AP by Bucket tags: - Pivot description: AP by Bucket parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: bucketstart in: query required: true schema: type: string maxLength: 8 - name: bucketend in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/accountsreceivablebuckets: get: operationId: arBucketDefinitions summary: AR Bucket Definitions tags: - Pivot description: Bucket definitions for AR parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/accountsreceivable: get: operationId: arByBucket summary: AR By Bucket tags: - Pivot description: AR By Bucket parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: bucketstart in: query required: true schema: type: string maxLength: 8 - name: bucketend in: query required: true schema: type: string maxLength: 8 - name: type in: query required: false schema: type: string enum: - I - C description: Get (I)nvoice or (C)redit items only. Default returns all types. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/salesvolume: get: operationId: salesVolumeByDate summary: Sales Volume by Date tags: - Pivot description: Sales Volume by Date parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/inventoryvaluation: get: operationId: inventoryValuation summary: Inventory Valuation tags: - Pivot description: Inventory Valuation list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadtimeslots: get: operationId: leadTimeSlots summary: Lead Time Slots tags: - Lead description: Get lead time slot list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadsbydate: get: operationId: leadsList summary: Leads list tags: - Lead description: Leads list by date range parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: status in: query required: false schema: type: string default: both enum: - open - closed - both description: Optional Lead status - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Optional Appointment Date - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Optional Appointment Date - name: startdate2 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Optional Last Edited Date - name: enddate2 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Optional Last Edited Date - name: startdate3 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Optional Created Date - name: enddate3 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Optional Created Date - name: term in: query required: false schema: type: string maxLength: 30 description: Optional Search term for customer name - name: ordstatuscode in: query required: false schema: type: string maxLength: 10 description: Optional - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/lead: post: operationId: createsLead summary: Creates Lead tags: - Lead description: Creates Lead parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: rooms[] in: query required: false schema: type: array items: type: string description: Selected Rooms - name: pctypes[] in: query required: false schema: type: array items: type: string description: Selected Product Types requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. jobstat: type: string maxLength: 10 description: Lead status leadfirstname: type: string maxLength: 20 leadlastname: type: string maxLength: 20 shaddr1: type: string maxLength: 30 shaddr2: type: string maxLength: 30 shcity: type: string maxLength: 30 shstate: type: string maxLength: 30 shzip: type: string maxLength: 30 description: Required when company control is on. leadphone1: type: string maxLength: 12 description: Format - 111-111-1111. text1: type: string maxLength: 1 description: 1 for Yes 0 for No leadphone2: type: string maxLength: 12 description: Format - 111-111-1111 text2: type: string maxLength: 1 description: 1 for Yes 0 for No leadphone3: type: string maxLength: 12 description: Format - 111-111-1111 text3: type: string maxLength: 1 description: 1 for Yes 0 for No leademail: type: string maxLength: 120 description: Required when company control is on. date: type: string maxLength: 8 description: Format - YYYYMMDD leadtime: type: string maxLength: 8 ordsalesrep1: type: string maxLength: 3 special: type: string maxLength: 20 territory: type: string maxLength: 8 quicknote: type: string maxLength: 30 po: type: string maxLength: 13 canceled: type: string maxLength: 1 description: 1 for Yes 0 for No duplicate: type: string maxLength: 1 description: 1 for Yes 0 for No otherfirst: type: string maxLength: 20 otherlast: type: string maxLength: 20 crossstreets: type: string maxLength: 20 commcode: type: string maxLength: 2 zone: type: string maxLength: 10 married: type: string maxLength: 1 description: Y for Yes N for No homeowner: type: string maxLength: 1 description: Y for Yes N for No subterritory: type: string maxLength: 10 budget: type: string maxLength: 8 gclid: type: string required: - company - branch - leadfirstname - leadlastname - shaddr1 - shcity - shstate - leadphone1 responses: '200': description: OK content: application/json: schema: type: object properties: LEAD_UPDATED: type: string patch: operationId: updateLead summary: Update lead tags: - Lead description: Update lead parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: rooms[] in: query required: false schema: type: array items: type: string description: Selected Rooms - name: pctypes[] in: query required: false schema: type: array items: type: string description: Selected Product Types requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. jobstat: type: string maxLength: 10 description: Lead status leadfirstname: type: string maxLength: 20 leadlastname: type: string maxLength: 20 shaddr1: type: string maxLength: 30 shaddr2: type: string maxLength: 30 shcity: type: string maxLength: 30 shstate: type: string maxLength: 30 shzip: type: string maxLength: 30 description: Required when company control is on. leadphone1: type: string maxLength: 12 description: Format - 111-111-1111. text1: type: string maxLength: 1 description: 1 for Yes 0 for No leadphone2: type: string maxLength: 12 description: Format - 111-111-1111 text2: type: string maxLength: 1 description: 1 for Yes 0 for No leadphone3: type: string maxLength: 12 description: Format - 111-111-1111 text3: type: string maxLength: 1 description: 1 for Yes 0 for No leademail: type: string maxLength: 120 description: Required when company control is on. date: type: string maxLength: 8 description: Format - YYYYMMDD leadtime: type: string maxLength: 8 ordsalesrep1: type: string maxLength: 3 special: type: string maxLength: 20 territory: type: string maxLength: 8 quicknote: type: string maxLength: 30 po: type: string maxLength: 13 canceled: type: string maxLength: 1 description: 1 for Yes 0 for No duplicate: type: string maxLength: 1 description: 1 for Yes 0 for No otherfirst: type: string maxLength: 20 otherlast: type: string maxLength: 20 crossstreets: type: string maxLength: 20 commcode: type: string maxLength: 2 zone: type: string maxLength: 10 married: type: string maxLength: 1 description: Y for Yes N for No homeowner: type: string maxLength: 1 description: Y for Yes N for No subterritory: type: string maxLength: 10 budget: type: string maxLength: 8 gclid: type: string required: - company - branch - leadfirstname - leadlastname - shaddr1 - shcity - shstate responses: '200': description: OK content: application/json: schema: type: object properties: LEAD_CODIV: type: string LEAD_WHSE: type: string LEAD_NUMBER: type: string LEAD_STATUS: type: string LEAD_STATUS_CODE: type: string LEAD_DATE: type: string LEAD_CUST_FIRST_NAME: type: string LEAD_CUST_LAST_NAME: type: string LEAD_CUST_ADDR1: type: string LEAD_CUST_ADDR2: type: string LEAD_CUST_CITY: type: string LEAD_CUST_STATE: type: string LEAD_CUST_ZIPCD: type: string LEAD_CUST_PHONE1: type: string LEAD_CUST_PHONE2: type: string LEAD_CUST_PHONE3: type: string LEAD_CUST_EMAIL: type: string LEAD_SCHEDULE_DATE: type: string LEAD_SCHEDULE_TIME: type: string LEAD_SCHEDULE_SLSREP: type: string LEAD_SPECIAL_CODE: type: string LEAD_TERRITORY: type: string LEAD_NOTE: type: string LEAD_USER: type: string LEAD_PONO: type: string LEAD_DMO_ORDNO: type: string LEAD_QMO_ORDNO: type: string LEAD_REOPEN: type: string LEAD_CANCELLED: type: string LEAD_DUPLICATE: type: string get: operationId: leadDetail summary: Lead detail tags: - Lead description: Specific Lead information parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: leadno in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadnotes: post: operationId: updatesLeadNotes summary: Updates Lead Notes tags: - Lead description: Updates Lead Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 description: Format - lead number noteslist: type: array items: type: array items: type: string required: - company - branch - leadno - noteslist responses: '200': description: OK content: application/json: schema: type: object properties: LEAD_UPDATED: type: string /{alias}/leadquicknote: post: operationId: updatesLeadQuickNote summary: Updates Lead Quick Note tags: - Lead description: Updates Lead Quick Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 description: Format - lead number noteslist: type: array items: type: array items: type: string required: - company - branch - leadno - noteslist responses: '200': description: OK content: application/json: schema: type: object properties: LEAD_UPDATED: type: string /{alias}/leaddispoqty: post: operationId: updatesLeadDispStyleQuantityNotes summary: Updates Lead Disp Style/Quantity Notes tags: - Lead description: Updates Lead Disp Style/Quantity Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 description: Format - lead number noteslist: type: array items: type: array items: type: string required: - company - branch - leadno - noteslist responses: '200': description: OK content: application/json: schema: type: object properties: LEAD_UPDATED: type: string /{alias}/leaddispo: post: operationId: updatesLeadDispoNotes summary: Updates Lead Dispo Notes tags: - Lead description: Updates Lead Dispo Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 description: Format - lead number noteslist: type: array items: type: array items: type: string required: - company - branch - leadno - noteslist responses: '200': description: OK content: application/json: schema: type: object properties: LEAD_UPDATED: type: string /{alias}/leadnonq: get: operationId: leadNonqualifiedCategories summary: Lead Nonqualified Categories tags: - Lead description: Lead Nonqualified Categories - Alert Codes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: leadno in: query required: false schema: type: string maxLength: 8 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string patch: operationId: updatesNonqualifiersOnALeadSendingExistingDescriptionWillRemoveFromALead summary: Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead. tags: - Lead description: Updates an existing Lead Office Note. Returns success message. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: nonqdesc in: query required: true schema: type: string maxLength: 20 requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadzone: get: operationId: leadZoneCategories summary: Lead Zone Categories tags: - Lead description: Lead zones parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch specific lead zone info when applicable. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/terrsub: get: operationId: subterritoryCategories summary: Subterritory Categories tags: - Lead description: Subterritories parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: territory in: query required: false schema: type: string maxLength: 8 description: Optional - enter to return details about one territory responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadexceptions: get: operationId: leadExceptionCategories summary: Lead Exception Categories tags: - Lead description: Scheduling slot exceptions for lead sales reps parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: zone in: query required: false schema: type: string maxLength: 10 description: Optional - name: salesid in: query required: false schema: type: string maxLength: 3 description: Optional - name: startdate in: query required: true schema: type: string maxLength: 8 description: Optional. Format - YYYYMMDD - name: enddate in: query required: false schema: type: string maxLength: 8 description: Optional. Format - YYYYMMDD responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadofficenotes: get: operationId: leadOfficeNotesCategories summary: Lead Office Notes Categories tags: - Lead description: Get Lead Office Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: leadpage in: query required: false schema: type: string maxLength: 2 description: Optional - Lead Office Note Page Number responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string post: operationId: createLeadOfficeNotes summary: Create Lead Office Notes tags: - Lead description: Creates a new Lead Office Note. Returns success message. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 noteslist: type: array items: type: array items: type: string required: - company - branch - leadno - noteslist responses: '200': description: OK content: application/json: schema: type: object properties: Success: type: string patch: operationId: updateLeadOfficeNotes summary: Update Lead Office Notes tags: - Lead description: Updates an existing Lead Office Note. Returns success message. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: page in: query required: true schema: type: string maxLength: 4 - name: noteslist in: query required: true schema: type: array items: type: string requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: Success: type: string /{alias}/leadsched: get: operationId: leadSchedulingCategories summary: Lead Scheduling Categories tags: - Lead description: Scheduling slots for lead sales reps parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: zone in: query required: false schema: type: string maxLength: 10 - name: salesid in: query required: false schema: type: string maxLength: 3 - name: date in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/nonqualified: get: operationId: nonqualifiedCategories summary: Nonqualified Categories tags: - Lead description: Nonqualified Categories parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadmattype: get: operationId: leadMatTypeCategories summary: Lead Mat Type Categories tags: - Lead description: Material Type for Leads Product Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadappt: get: operationId: leadAppointments summary: Lead Appointments tags: - Lead description: Scheduled Lead Appointments parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: salesid in: query required: false schema: type: string maxLength: 3 description: Optional - name: leadno in: query required: false schema: type: string maxLength: 8 description: Optional - name: leadtime in: query required: false schema: type: string maxLength: 8 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadproductnotes: post: operationId: createLeadProductNotes summary: Create Lead Product Notes tags: - Lead description: Creates & returns a new lead product note. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 pctype: type: string maxLength: 20 materialtype: type: string maxLength: 20 room: type: string maxLength: 20 matnote: type: string maxLength: 20 required: - company - branch - leadno - pctype - materialtype - room - matnote responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string patch: operationId: updatesLeadProductNotes summary: Updates Lead Product Notes tags: - Lead description: Updates an existing lead product note. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: seq in: query required: true schema: type: string maxLength: 4 description: Format - 0001. - name: pctype in: query required: false schema: type: string maxLength: 6 description: Optional - name: mattype in: query required: false schema: type: string maxLength: 20 description: Optional - name: room in: query required: false schema: type: string maxLength: 20 description: Optional - name: leadmatnote in: query required: false schema: type: string maxLength: 20 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: Success: type: string get: operationId: getsLeadProductNotes summary: Gets Lead Product Notes tags: - Lead description: Returns all lead product notes based on either branch or specific lead number parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: leadno in: query required: false schema: type: string maxLength: 8 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string delete: operationId: deletesLeadProductNotes summary: Deletes Lead Product Notes tags: - Lead description: Deletes an existing lead product note by sequence parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: seq in: query required: true schema: type: string maxLength: 4 description: Format - 0001. responses: '200': description: OK content: application/json: schema: type: object properties: Success: type: string /{alias}/leadroom: get: operationId: getLeadRoom summary: Get Lead Room tags: - Lead description: Returns lead rooms by branch or specific lead number parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: leadno in: query required: false schema: type: string maxLength: 8 description: Optional requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string post: operationId: createLeadRoom summary: Create Lead Room tags: - Lead description: Creates a new lead room for a specific lead number parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 room: type: string maxLength: 20 required: - company - branch - leadno - room responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string patch: operationId: updateLeadRoom summary: Update Lead Room tags: - Lead description: Update Existing Lead Room by Lead Number parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: room in: query required: true schema: type: string maxLength: 20 description: This is the existing room to be replaced - name: newroom in: query required: true schema: type: string maxLength: 20 description: The new room replacing the existing room requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string delete: operationId: removeLeadRoom summary: Remove Lead Room tags: - Lead description: Deletes Existing Lead Room by Lead Number parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: leadno in: query required: true schema: type: string maxLength: 8 - name: room in: query required: true schema: type: string maxLength: 20 description: This is the existing room to be deleted requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: LEADROOM_CODIV: type: string LEADROOM_WHSE: type: string LEADROOM_LEADNO: type: string LEADROOM_ROOM: type: string /{alias}/roomfile: get: operationId: roomFile summary: Room File tags: - Lead description: Returns all rooms by company parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: room in: query required: false schema: type: string maxLength: 20 description: Optional requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. required: - company responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/allavailability: get: operationId: getAllAvailability summary: Get All Availability tags: - Lead description: Get all available time slots for a specific sales id parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: startdate in: query required: true schema: type: string maxLength: 8 - name: enddate in: query required: true schema: type: string maxLength: 8 - name: salesid in: query required: false schema: type: string maxLength: 3 description: Optional - name: zone in: query required: false schema: type: string maxLength: 10 description: optional responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/leadspecials: get: operationId: getLeadSpecials summary: Get Lead Specials tags: - Lead description: Get Lead Specials parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/convertleadtoquote: post: operationId: convertsAnExistingLeadIntoAQuote summary: Converts an existing lead into a quote tags: - Lead description: Converts an existing lead into a quote parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. leadno: type: string maxLength: 8 ordcustid: type: string maxLength: 8 description: Existing customer ID closelead: type: string maxLength: 1 description: Lead will close on convert if Y is sent or the user does not have permission to reopen leads required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: QMO_CODIV: type: string QMO_WHSE: type: string QMO_ORDNO: type: string QMH_STATUS: type: string QMH_STATUSCODE: type: string QMH_CUSTID: type: string QMH_TYPE: type: string QMH_SHCODE: type: string QMH_SHNAME: type: string QMH_SHADDR1: type: string QMH_SHADDR2: type: string QMH_SHCITY: type: string QMH_SHSTATE: type: string QMH_SHZIP: type: string QMH_JOBTYPE: type: string QMH_JOBNUM: type: string QMH_TAXTYPE: type: string QMH_SPECIAL1: type: string QMH_JOBTOTAL: type: string QMH_WONUM: type: string QMH_CUSTPO: type: string QMH_ATTN: type: string QMH_QRDNO: type: string QMH_INSTALLDATE: type: string QMH_DATE: type: string QMH_SHPHONE1: type: string QMH_SHFAX: type: string QMH_SHCONTACT: type: string QMH_INSDATE_INITIALS: type: string QMH_TYPEDESC: type: string QMH_CARE: type: string QMH_ORDEREDBY: type: string QMH_SMOP: type: string QRDE_EMAIL: type: string QMH_SALESREP1: type: string QMH_SALESREP1_NAME: type: string QMH_SALESREP1_PHONE1: type: string QMH_SALESREP1_PHONE2: type: string QMH_SALESREP2: type: string QMH_SALESREP2_NAME: type: string QMH_SALESREP2_PHONE1: type: string QMH_SALESREP2_PHONE2: type: string C_NAME: type: string C_PHONE: type: string C_PHONE2: type: string C_FAX: type: string C_EMAIL: type: string /{alias}/bundle: post: operationId: createBundleJobQuoteRecord summary: Create Bundle(Job/Quote) Record tags: - Bundle description: Creates Bundle Record for a Quote or Job based on 'type' of ('quote' or 'order') parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: type in: query required: true schema: type: string maxLength: 5 description: quote, order (Sets mode of call) - name: bundlename in: query required: true schema: type: string maxLength: 30 - name: order in: query required: false schema: type: string maxLength: 6 description: required when type is order - name: quote in: query required: false schema: type: string maxLength: 6 description: required when type is quote requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: BUNDLE_ORDNO: type: string BUNDLE_SEQ: type: string BUNDLE_NAME: type: string patch: operationId: updateBundleJobQuoteNameBySequence summary: Update Bundle(Job/Quote) Name by sequence tags: - Bundle description: Updates Bundle Name by sequence for a Quote or Job based on 'type' of ('quote' or 'order') parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: type in: query required: true schema: type: string maxLength: 5 description: quote, order (Sets mode of call) - name: bundleseq in: query required: true schema: type: string maxLength: 3 description: sequence to rename - name: bundlename in: query required: true schema: type: string maxLength: 30 - name: order in: query required: false schema: type: string maxLength: 6 description: required when type is order - name: quote in: query required: false schema: type: string maxLength: 6 description: required when type is quote requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: BUNDLE_ORDNO: type: string BUNDLE_SEQ: type: string BUNDLE_NAME: type: string get: operationId: returnBundleJobQuoteNameBySequence summary: Return Bundle(Job/Quote) Name by sequence tags: - Bundle description: Return Bundle Name by sequence for a Quote or Job based on 'type' of ('quote' or 'order') or all if no sequence provided parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: type in: query required: true schema: type: string maxLength: 5 description: quote, order (Sets mode of call) - name: bundleseq in: query required: false schema: type: string maxLength: 3 description: when not sent all - name: order in: query required: false schema: type: string maxLength: 6 description: required when type is order - name: quote in: query required: false schema: type: string maxLength: 6 description: required when type is quote requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: BUNDLE_ORDNO: type: string BUNDLE_SEQ: type: string BUNDLE_NAME: type: string /{alias}/quotes: get: operationId: quotesByFollowUpDateRange summary: Quotes by follow up date range tags: - Quote description: Quotes by follow up date range parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks up Follow-Up Date. - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks up Follow-Up Date - name: startdate2 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks up Created Date. - name: enddate2 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks up Created Date. - name: customer in: query required: false schema: type: string maxLength: 8 description: Optional - name: status in: query required: false schema: type: string maxLength: 7 description: Optional, open/closed/both responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/quote: post: operationId: createQuote summary: Create Quote tags: - Quote description: Creates an Quote. Returns the key (header info) of the Quote updated. Only fields sent will update. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. ordstatus: type: string maxLength: 12 custpo: type: string maxLength: 15 ordcustid: type: string maxLength: 8 ordtype: type: string maxLength: 1 ordsalesrep1: type: string maxLength: 3 description: Note - assumes user salesperson initials if not sent and if user is salesperson. ordsalesrep2: type: string maxLength: 3 ordjobtype: type: string maxLength: 2 ordstatuscode: type: string maxLength: 10 shcode: type: string maxLength: 4 shname: type: string maxLength: 30 shaddr1: type: string maxLength: 30 shaddr2: type: string maxLength: 30 shctyst: type: string maxLength: 30 shcity: type: string maxLength: 30 shstate: type: string maxLength: 30 shzip: type: string maxLength: 10 shbuilding: type: string maxLength: 23 description: When used, will override shaddr2 field shunit: type: string maxLength: 6 description: When used, will override shaddr2 field insdate: type: string maxLength: 8 description: YYYYMMDD Changes the followup date or quote. required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: QMO_CODIV: type: string QMO_WHSE: type: string QMO_ORDNO: type: string QMH_STATUS: type: string QMH_STATUSCODE: type: string QMH_CUSTID: type: string QMH_TYPE: type: string QMH_SHCODE: type: string QMH_SHNAME: type: string QMH_SHADDR1: type: string QMH_SHADDR2: type: string QMH_SHCITY: type: string QMH_SHSTATE: type: string QMH_SHZIP: type: string QMH_JOBTYPE: type: string QMH_JOBNUM: type: string QMH_TAXTYPE: type: string QMH_SPECIAL1: type: string QMH_JOBTOTAL: type: string QMH_WONUM: type: string QMH_CUSTPO: type: string QMH_ATTN: type: string QMH_QRDNO: type: string QMH_INSTALLDATE: type: string QMH_DATE: type: string QMH_SHPHONE1: type: string QMH_SHFAX: type: string QMH_SHCONTACT: type: string QMH_INSDATE_INITIALS: type: string QMH_TYPEDESC: type: string QMH_CARE: type: string QMH_ORDEREDBY: type: string QMH_SMOP: type: string QRDE_EMAIL: type: string QMH_SALESREP1: type: string QMH_SALESREP1_NAME: type: string QMH_SALESREP1_PHONE1: type: string QMH_SALESREP1_PHONE2: type: string QMH_SALESREP2: type: string QMH_SALESREP2_NAME: type: string QMH_SALESREP2_PHONE1: type: string QMH_SALESREP2_PHONE2: type: string C_NAME: type: string C_PHONE: type: string C_PHONE2: type: string C_FAX: type: string C_EMAIL: type: string patch: operationId: updateQuote summary: Update Quote tags: - Quote description: Updates an existing Quote. Returns the key (header info) of the Quote updated. Only fields sent will update. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: true schema: type: string maxLength: 6 - name: ordstatus in: query required: false schema: type: string maxLength: 12 - name: custpo in: query required: false schema: type: string maxLength: 15 - name: ordcustid in: query required: false schema: type: string maxLength: 8 - name: ordtype in: query required: false schema: type: string maxLength: 1 - name: ordsalesrep1 in: query required: false schema: type: string maxLength: 3 - name: ordsalesrep2 in: query required: false schema: type: string maxLength: 3 - name: ordjobtype in: query required: false schema: type: string maxLength: 2 - name: ordstatuscode in: query required: false schema: type: string maxLength: 10 - name: shcode in: query required: false schema: type: string maxLength: 4 - name: shname in: query required: false schema: type: string maxLength: 30 - name: shaddr1 in: query required: false schema: type: string maxLength: 30 - name: shaddr2 in: query required: false schema: type: string maxLength: 30 - name: shctyst in: query required: false schema: type: string maxLength: 30 - name: shcity in: query required: false schema: type: string maxLength: 30 - name: shstate in: query required: false schema: type: string maxLength: 30 - name: shzip in: query required: false schema: type: string maxLength: 10 - name: shbuilding in: query required: false schema: type: string maxLength: 23 description: When used, will override shaddr2 field - name: shunit in: query required: false schema: type: string maxLength: 6 description: When used, will override shaddr2 field - name: insdate in: query required: false schema: type: string maxLength: 8 description: YYYYMMDD Changes the follow up date for quote responses: '200': description: OK content: application/json: schema: type: object properties: QMO_CODIV: type: string QMO_WHSE: type: string QMO_ORDNO: type: string QMH_STATUS: type: string QMH_STATUSCODE: type: string QMH_CUSTID: type: string QMH_TYPE: type: string QMH_SHCODE: type: string QMH_SHNAME: type: string QMH_SHADDR1: type: string QMH_SHADDR2: type: string QMH_SHCITY: type: string QMH_SHSTATE: type: string QMH_SHZIP: type: string QMH_JOBTYPE: type: string QMH_JOBNUM: type: string QMH_TAXTYPE: type: string QMH_SPECIAL1: type: string QMH_JOBTOTAL: type: string QMH_WONUM: type: string QMH_CUSTPO: type: string QMH_ATTN: type: string QMH_QRDNO: type: string QMH_INSTALLDATE: type: string QMH_DATE: type: string QMH_SHPHONE1: type: string QMH_SHFAX: type: string QMH_SHCONTACT: type: string QMH_INSDATE_INITIALS: type: string QMH_TYPEDESC: type: string QMH_CARE: type: string QMH_ORDEREDBY: type: string QMH_SMOP: type: string QRDE_EMAIL: type: string QMH_SALESREP1: type: string QMH_SALESREP1_NAME: type: string QMH_SALESREP1_PHONE1: type: string QMH_SALESREP1_PHONE2: type: string QMH_SALESREP2: type: string QMH_SALESREP2_NAME: type: string QMH_SALESREP2_PHONE1: type: string QMH_SALESREP2_PHONE2: type: string C_NAME: type: string C_PHONE: type: string C_PHONE2: type: string C_FAX: type: string C_EMAIL: type: string get: operationId: getQuote summary: Get Quote tags: - Quote description: Get Quote header information parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: true schema: type: string maxLength: 6 responses: '200': description: OK content: application/json: schema: type: object properties: QMO_CODIV: type: string QMO_WHSE: type: string QMO_ORDNO: type: string QMH_STATUS: type: string QMH_STATUSCODE: type: string QMH_CUSTID: type: string QMH_TYPE: type: string QMH_SHCODE: type: string QMH_SHNAME: type: string QMH_SHADDR1: type: string QMH_SHADDR2: type: string QMH_SHCITY: type: string QMH_SHSTATE: type: string QMH_SHZIP: type: string QMH_JOBTYPE: type: string QMH_JOBNUM: type: string QMH_TAXTYPE: type: string QMH_SPECIAL1: type: string QMH_JOBTOTAL: type: string QMH_WONUM: type: string QMH_CUSTPO: type: string QMH_ATTN: type: string QMH_QRDNO: type: string QMH_INSTALLDATE: type: string QMH_DATE: type: string QMH_SHPHONE1: type: string QMH_SHFAX: type: string QMH_SHCONTACT: type: string QMH_INSDATE_INITIALS: type: string QMH_TYPEDESC: type: string QMH_CARE: type: string QMH_ORDEREDBY: type: string QMH_SMOP: type: string QRDE_EMAIL: type: string QMH_SALESREP1: type: string QMH_SALESREP1_NAME: type: string QMH_SALESREP1_PHONE1: type: string QMH_SALESREP1_PHONE2: type: string QMH_SALESREP2: type: string QMH_SALESREP2_NAME: type: string QMH_SALESREP2_PHONE1: type: string QMH_SALESREP2_PHONE2: type: string C_NAME: type: string C_PHONE: type: string C_PHONE2: type: string C_FAX: type: string C_EMAIL: type: string /{alias}/quoteline: post: operationId: createQuoteLine summary: Create Quote Line tags: - Quote description: 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 parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. quote: type: string maxLength: 6 ordlseq: type: string maxLength: 13 ordlb2bsku: type: string maxLength: 30 ordlbarcode: type: string maxLength: 30 ordlwqty: type: string maxLength: 9 ordlsqty: type: string maxLength: 9 ordlprice: type: string maxLength: 9 laborunitcost: type: string maxLength: 9 taxable: type: string maxLength: 1 description: Y or N required: - company - branch - quote responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string QRDNO: type: string LINE: type: string get: operationId: getQuoteLines summary: Get quote lines tags: - Quote description: Get quote lines parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: true schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 description: Optional - Sending will return single requested line. responses: '200': description: OK content: application/json: schema: type: object properties: QMI_ORDNO: type: string QMI_LNNUM: type: string QMI_RECSTAT: type: string QMI_CAT_SEQUENCE: type: string QMI_PRODCODE: type: string QMI_STYLE: type: string QMI_STYNUMBER: type: string QMI_COLOR: type: string QMI_COLNUMBER: type: string QMI_QTYASSIGNED: type: string QMI_SQUANTITY: type: string QMI_WQUANTITY: type: string QMI_SUNITS: type: string QMI_WUNITS: type: string QMI_PRICE: type: string QMI_TOTAL: type: string QMI_PONO: type: string QMI_TAXYN: type: string QMI_TAX: type: string QMI_INSTRUCTIONS: type: string QMI_BUNDLE_SEQ: type: string BQ_BUNDLE_NAME: type: string patch: operationId: updateQuoteLine summary: Update Quote Line tags: - Quote description: Updates a line on an existing quote. Returns the key (header info) of the quote updated. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: true schema: type: string maxLength: 6 - name: lnnum in: query required: true schema: type: string maxLength: 3 - name: ordlwqty in: query required: false schema: type: string maxLength: 9 - name: ordlsqty in: query required: false schema: type: string maxLength: 9 - name: ordlprice in: query required: false schema: type: string maxLength: 9 - name: laborunitcost in: query required: false schema: type: string maxLength: 9 - name: taxable in: query required: false schema: type: string maxLength: 1 description: Y or N responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string QRDNO: type: string LINE: type: string delete: operationId: deleteQuoteLine summary: Delete Quote Line tags: - Quote description: Deletes a line on an existing quote. Returns the key (header info) of the quote deleted. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: true schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string QRDNO: type: string LINE: type: string /{alias}/quotelinecomments: post: operationId: createQuoteLineComment summary: Create Quote Line Comment tags: - Quote description: Creates a quote line comment. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. quote: type: string maxLength: 6 lnnum: type: string maxLength: 3 linenote: type: string maxLength: 70 commenttype: type: string maxLength: 1 description: W = work order, C = customer, B= both, N = none required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: QLC_CODIV: type: string QLC_WHSE: type: string QLC_ORDNO: type: string QLC_LNNUM: type: string QLC_SEQ: type: string QLC_TYPE: type: string QLC_COMMENT: type: string QLC_WEBNAME: type: string QLC_DATE: type: string QLC_TIME: type: string QLC_REQUIRED: type: string QLC_NOTE_NUM: type: string patch: operationId: updateQuoteLineComment summary: Update Quote Line Comment tags: - Quote description: Updates an existing quote line comment. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: false schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 - name: commseq in: query required: false schema: type: string maxLength: 3 - name: linenote in: query required: false schema: type: string maxLength: 53 responses: '200': description: OK content: application/json: schema: type: object properties: QLC_CODIV: type: string QLC_WHSE: type: string QLC_ORDNO: type: string QLC_LNNUM: type: string QLC_SEQ: type: string QLC_TYPE: type: string QLC_COMMENT: type: string QLC_WEBNAME: type: string QLC_DATE: type: string QLC_TIME: type: string QLC_REQUIRED: type: string QLC_NOTE_NUM: type: string get: operationId: getQuoteLineCommments summary: Get Quote line commments tags: - Quote description: Get all quote line commments parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: false schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/quotenote: get: operationId: readsAQuoteNote summary: Reads a Quote Note tags: - Quote description: Reads a Quote Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: quote in: query required: true schema: type: string maxLength: 6 - name: jobpage in: query required: false schema: type: string maxLength: 2 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BR: type: string ORDNO: type: string PAGE: type: string LINE: type: string NOTE: type: string /{alias}/quotelinesub: get: operationId: getQrdlsubRecords summary: Get QRDLSUB Records tags: - Quote description: Get QRDLSUB Records parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: jobstatus in: query required: false schema: type: string maxLength: 7 description: Optional, open/closed. When not sent open quotes are returned. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: quote in: query required: false schema: type: string maxLength: 6 description: Optional - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/lowstock: get: operationId: getCatalogItemsBelowSafetyStockLimit summary: Get Catalog Items below Safety Stock Limit tags: - Inventory description: Get Catalog Items below Safety Stock Limit parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/received: get: operationId: assignedInventoryReceived summary: Assigned Inventory Received tags: - Inventory description: Assigned Inventory Received parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/inventorypointers: get: operationId: getInventoryPointRecords summary: Get Inventory Point records tags: - Inventory description: Get all inventory point records for open POs with open PO lines parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: order in: query required: false schema: type: string maxLength: 6 description: Optional - name: startdate in: query required: false schema: type: string maxLength: 8 description: Optional - Format - YYYYMMDD - Use to return records with an audit within specific date range - name: enddate in: query required: false schema: type: string maxLength: 8 description: Optional - Format - YYYYMMDD - Use to return records with an audit within specific date range responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/inventorybyauditdate: get: operationId: getInventoryFileRecords summary: Get Inventory File Records tags: - Inventory description: Returns all inventory file records by company, branch, and/or audit date parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: catseq in: query required: false schema: type: string maxLength: 13 description: Optional - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks Audit Date in Range. - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - - Looks Audit Date in Range. responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/assignedinventory: get: operationId: getInventoryAssignedOnJob summary: Get Inventory Assigned on Job tags: - Inventory description: Get Inventory Assigned on Job parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. requestBody: required: true content: application/json: schema: type: object properties: job: type: string maxLength: 6 required: - job responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string patch: operationId: unassignInventoryOnJob summary: Unassign Inventory on Job tags: - Inventory description: Unassign Inventory on Job parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: true schema: type: string maxLength: 6 - name: lnnum in: query required: true schema: type: string maxLength: 3 - name: invpoint in: query required: true schema: type: string maxLength: 36 description: Full inventory pointer key responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string post: operationId: assignInventoryToJob summary: Assign Inventory to Job tags: - Inventory description: Assign Inventory to Job parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. job: type: string maxLength: 6 lnnum: type: string maxLength: 3 barcode: type: string maxLength: 36 description: Item barcode / Inventory Serialnumber. box: type: string maxLength: 1 description: Required when by box. quantity: type: string maxLength: 15 description: Used when specifying a quantity other than full quantity available. required: - company - branch - job - lnnum - barcode - box - quantity responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/invoice: get: operationId: invoiceHeader summary: Invoice Header tags: - Invoice description: Invoice header by invoice number parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: invoice in: query required: false schema: type: string maxLength: 8 description: Invoice number responses: '200': description: OK content: application/json: schema: type: object properties: KEY: type: string IVC_KEY: type: string IVC_CODIV: type: string IVC_WHSE: type: string IVC_INVNO: type: integer IVC_STATUS: type: string IVC_TYPE: type: string IVC_ORDNO: type: integer IVC_MATERIAL: type: number IVC_LABOR: type: number IVC_SPECIAL: type: number IVC_TOTTAX: type: number IVC_INVOICE: type: number IVC_DATE: type: integer IVC_CUSTOMER: type: string IVC_OTCSALE: type: string IVC_CURRDATE: type: integer IVC_RDATE: type: integer IVC_CURRTIME: type: integer IVC_USERID: type: string IVC_DEVICE: type: string IVC_TYPEDESC: type: string IVC_CUSTPO: type: string IVC_INSTALLDATE: type: integer IVC_DISCOUNT: type: number IVC_PRINT_QTY: type: string IVC_PRINT_PRICE: type: string IVC_PRINT_EXT: type: string IVC_DUEDATE: type: integer /{alias}/invoicelines: get: operationId: getInvoiceLines summary: Get Invoice Lines tags: - Invoice description: Get Invoice Lines parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: invoice in: query required: false schema: type: string maxLength: 6 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/salesinvoice: get: operationId: invoiceDownload summary: Invoice download tags: - Invoice description: Download Sales Invoice PDF parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: Invoice branch - name: invoice in: query required: true schema: type: string maxLength: 6 description: 6 digit Invoice responses: '200': description: OK /{alias}/invoicecommission: get: operationId: getInvoiceCommissionInfo summary: Get Invoice Commission Info tags: - Invoice description: Get Invoice Commission Info parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: salesid in: query required: false schema: type: string maxLength: 3 description: Optional - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/jobcost: get: operationId: getJobCostInfo summary: Get Job Cost Info tags: - Invoice description: Get Job Cost Info parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: order in: query required: false schema: type: string maxLength: 6 description: Optional - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Job audit date - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Job audit date - name: startdate2 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Pay date - name: enddate2 in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Pay date responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/ARNotes: get: operationId: arNotesByBucket summary: AR Notes by Bucket tags: - Accounts Receivable description: AR Notes by Bucket parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: bucketstart in: query required: true schema: type: string maxLength: 8 - name: bucketend in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/paytypecodes: get: operationId: paymentTypeCodes summary: Payment Type Codes tags: - Accounts Receivable description: Payment Type Codes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. requestBody: required: true content: application/json: schema: type: object properties: branch: type: string maxLength: 2 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/arcustomerregister: get: operationId: arCustomerRegister summary: AR Customer Register tags: - Accounts Receivable description: AR Customer Register parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 - name: enddate in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/arcustomerregisterhistory: get: operationId: arCustomerRegisterHistory summary: AR Customer Register History tags: - Accounts Receivable description: AR Customer Register History parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 - name: enddate in: query required: true schema: type: string maxLength: 8 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/salesreport: get: operationId: getPreBuiltSalesReport summary: Get pre-built sales report tags: - Reports description: Get a pre-built sales report for year parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: lastdays in: query required: false schema: type: string maxLength: 4 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. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/writtenbusiness: get: operationId: getWrittenBusinessReport summary: Get written business report tags: - Reports description: Get written business report by date range parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: lastdays in: query required: false schema: type: string maxLength: 4 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. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/writtenbusinessdetail: get: operationId: getWrittenBusinessReportDetail summary: Get written business report detail tags: - Reports description: Get written business report detail by date range parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: lastdays in: query required: false schema: type: string maxLength: 4 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. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/orderauditbydate: get: operationId: auditCreateRecordForOrder summary: Audit create record for order tags: - Audit description: Audit create record for order parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: lastdays in: query required: false schema: type: string maxLength: 4 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. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/quoteauditbydate: get: operationId: auditCreateRecordForQuote summary: Audit create record for quote tags: - Audit description: Audit create record for quote parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: lastdays in: query required: false schema: type: string maxLength: 4 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. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/glchartofaccounts: get: operationId: getGlChartOfAccounts summary: Get GL Chart of Accounts tags: - General Ledger description: Get GL Chart of Accounts parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/glreportformatlist: get: operationId: getGlReportFormatList summary: Get GL Report Format List tags: - General Ledger description: Get GL Report Format List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/gldetailbyperiod: get: operationId: getGlDetailByPeriod summary: Get GL Detail By Period tags: - General Ledger description: Get GL Detail by Period parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: glseq in: query required: true schema: type: string maxLength: 13 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/glperiodtable: get: operationId: getGlDetailByPeriod1 summary: Get GL Detail By Period tags: - General Ledger description: Get GL Detail by Period parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/hhgetinvpointers: get: operationId: inventoryFromBarcodeScan summary: Inventory from barcode scan tags: - Handheld description: Inventory from barcode scan parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: barcode in: query required: true schema: type: string maxLength: 14 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/hhgetinvbylocation: get: operationId: inventoryByLocation summary: Inventory by location tags: - Handheld description: Inventory by location parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: location in: query required: true schema: type: string maxLength: 5 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/hhgetpricing: get: operationId: viewAJPricing summary: View A-J pricing tags: - Handheld description: View A-J pricing parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional, gets branch specific pricing when applicable. - name: barcode in: query required: false schema: type: string maxLength: 14 - name: catseq in: query required: false schema: type: string maxLength: 13 description: Barcode or Catseq required to return stock. If both are provided, only catseq is used. responses: '200': description: OK content: application/json: schema: type: object properties: BARCODE: type: string BRANCH: type: string PRODCODE: type: string STYLE: type: string STYLENUM: type: string COLOR: type: string COLORNUM: type: string BYBOX: type: string UNITPERBOX: type: string PRICEANAME: type: string PRICEAC: type: string PRICEAR: type: string PRICEBNAME: type: string PRICEBC: type: string PRICEBR: type: string PRICECNAME: type: string PRICECC: type: string PRICECR: type: string PRICEDNAME: type: string PRICEDC: type: string PRICEDR: type: string PRICEENAME: type: string PRICEEC: type: string PRICEER: type: string PRICEFNAME: type: string PRICEFC: type: string PRICEFR: type: string PRICEGNAME: type: string PRICEGC: type: string PRICEGR: type: string PRICEHNAME: type: string PRICEHC: type: string PRICEHR: type: string PRICEINAME: type: string PRICEIC: type: string PRICEIR: type: string PRICEJNAME: type: string PRICEJC: type: string PRICEJR: type: string SPECIALPRICEC: type: string SPECIALPRICER: type: string FLOAT_UNITPERBOX: type: string FLOAT_PRICENAMEA: type: string FLOAT_PRICEAC: type: string FLOAT_PRICEAR: type: string FLOAT_PRICENAMEB: type: string FLOAT_PRICEBC: type: string FLOAT_PRICEBR: type: string FLOAT_PRICENAMEC: type: string FLOAT_PRICECC: type: string FLOAT_PRICECR: type: string FLOAT_PRICENAMED: type: string FLOAT_PRICEDC: type: string FLOAT_PRICEDR: type: string FLOAT_PRICENAMEE: type: string FLOAT_PRICEEC: type: string FLOAT_PRICEER: type: string FLOAT_PRICENAMEF: type: string FLOAT_PRICEFC: type: string FLOAT_PRICEFR: type: string FLOAT_PRICENAMEG: type: string FLOAT_PRICEGC: type: string FLOAT_PRICEGR: type: string FLOAT_PRICENAMEH: type: string FLOAT_PRICEHC: type: string FLOAT_PRICEHR: type: string FLOAT_PRICENAMEI: type: string FLOAT_PRICEIC: type: string FLOAT_PRICEIR: type: string FLOAT_PRICENAMEJ: type: string FLOAT_PRICEJC: type: string FLOAT_PRICEJR: type: string FLOAT_SPECIALPRICEC: type: string FLOAT_SPECIALPRICER: type: string UOM: type: string WIDTH: type: string SIMPLE_TAXABLE: type: string /{alias}/getposbybarcode: get: operationId: findPoSByBarcode summary: Find PO's by barcode tags: - Handheld description: Find PO's by barcode parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 - name: barcode in: query required: true schema: type: string maxLength: 14 description: Inventory or Catalog Barcode, Either Barcode, Vendor, or Referrence Numberis required. - name: vendor in: query required: false schema: type: string maxLength: 8 description: Either Barcode, Vendor, or Referrence Numberis required. - name: refnum in: query required: false schema: type: string maxLength: 12 description: Either Barcode, Vendor, or Referrence Numberis required. - name: createpo in: query required: false schema: type: string maxLength: 4 description: HH User is in Create PO. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/getposbyvendor: get: operationId: findPoSByVendorThatCanHaveAdditionalMaterialAdded summary: Find PO's by vendor that can have additional material added tags: - Handheld description: Find PO's by vendor that can have additional material added parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: true schema: type: string maxLength: 14 - name: branch in: query required: true schema: type: string maxLength: 2 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/po: post: operationId: createPo summary: Create PO tags: - Handheld description: Creates a PO. Returns the key (header info) of the po created. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. barcode: type: string maxLength: 14 required: - company - branch - barcode responses: '200': description: OK content: application/json: schema: type: object properties: PO_KEY: type: string PO_PONO: type: string PO_DATE: type: string PO_CREATED_FROM_BC: type: string patch: operationId: updatePo summary: Update PO tags: - Purchase Order description: Updates an existing po. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: pono in: query required: true schema: type: string maxLength: 6 - name: vendor in: query required: false schema: type: string maxLength: 8 - name: ordstatus in: query required: false schema: type: string maxLength: 1 description: C will cancel PO. - name: date in: query required: false schema: type: string maxLength: 8 description: MMDDYYYY Format - name: terms in: query required: false schema: type: string maxLength: 10 - name: orderedby in: query required: false schema: type: string maxLength: 10 - name: takenby in: query required: false schema: type: string maxLength: 10 - name: refnum in: query required: false schema: type: string maxLength: 12 - name: stoporder in: query required: false schema: type: string maxLength: 1 description: Y - name: allocated in: query required: false schema: type: string maxLength: 1 description: 1 for Yes, 0 for No - name: exchangerate in: query required: false schema: type: string maxLength: 8 - name: includegross in: query required: false schema: type: string maxLength: 1 description: 1 for Yes, 0 for No - name: includefreight in: query required: false schema: type: string maxLength: 1 description: 1 for Yes, 0 for No - name: exchangefreight in: query required: false schema: type: string maxLength: 13 - name: exchangecost1 in: query required: false schema: type: string maxLength: 13 - name: exchangecost2 in: query required: false schema: type: string maxLength: 13 - name: exchangecost3 in: query required: false schema: type: string maxLength: 13 - name: includecost1 in: query required: false schema: type: string maxLength: 1 description: 1 for Yes, 0 for No - name: includecost2 in: query required: false schema: type: string maxLength: 1 description: 1 for Yes, 0 for No - name: includecost3 in: query required: false schema: type: string maxLength: 1 description: 1 for Yes, 0 for No - name: enableexpcost in: query required: false schema: type: string maxLength: 1 description: 1 for Yes, 0 for No responses: '200': description: OK content: application/json: schema: type: object properties: PO_KEY: type: string PO_PONO: type: string PO_DATE: type: string PO_CREATED_FROM_BC: type: string PO_LNNUM: type: string /{alias}/poline: post: operationId: createPoLine summary: Create PO Line tags: - Handheld description: Creates a line on an existing PO. Returns the key (header info) of the po updated. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. pono: type: string maxLength: 6 barcode: type: string maxLength: 14 description: Either barcode ro catalog sequence are required. catseq: type: string maxLength: 14 description: Either barcode ro catalog sequence are required. ordlwqty: type: string maxLength: 15 required: - company - branch - pono responses: '200': description: OK content: application/json: schema: type: object properties: PO_KEY: type: string PO_PONO: type: string PO_DATE: type: string PO_CREATED_FROM_BC: type: string PO_LNNUM: type: string get: operationId: getPoLines summary: Get PO lines tags: - Handheld description: Get PO lines parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: pono in: query required: true schema: type: string maxLength: 6 responses: '200': description: OK content: application/json: schema: type: object properties: PO_KEY: type: string PO_PONO: type: string PO_STATUS: type: string PO_VENDOR: type: string PO_COMMENT: type: string PO_REFNUM: type: string PO_DATE: type: string PO_TERMS: type: string PO_STOP_ORDER: type: string PO_CREATED_FROM_BC: type: string PO_LINES: type: array items: type: array items: type: string patch: operationId: updatePoLine summary: Update PO Line tags: - Handheld description: Updates a line on an existing po. Returns the key (header info) of the po updated. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: pono in: query required: true schema: type: string maxLength: 6 - name: lnnum in: query required: true schema: type: string maxLength: 3 - name: ordlwqty in: query required: false schema: type: string maxLength: 15 - name: unitcost in: query required: false schema: type: string maxLength: 10 - name: unitfreight in: query required: false schema: type: string maxLength: 10 - name: overbill in: query required: false schema: type: string maxLength: 8 - name: memo in: query required: false schema: type: string maxLength: 29 - name: refnum in: query required: false schema: type: string maxLength: 12 - name: reservenum in: query required: false schema: type: string maxLength: 12 - name: smop in: query required: false schema: type: string maxLength: 2 - name: freightterms in: query required: false schema: type: string maxLength: 3 - name: shipvia in: query required: false schema: type: string maxLength: 10 - name: minqty in: query required: false schema: type: string maxLength: 15 - name: maxqty in: query required: false schema: type: string maxLength: 15 - name: canceldays in: query required: false schema: type: string maxLength: 3 - name: shipdate in: query required: false schema: type: string maxLength: 8 - name: leaddays in: query required: false schema: type: string maxLength: 3 - name: arrivedate in: query required: false schema: type: string maxLength: 8 - name: dye in: query required: false schema: type: string maxLength: 10 - name: ordsalesrep1 in: query required: false schema: type: string maxLength: 3 - name: rollcutqty in: query required: false schema: type: string maxLength: 1 responses: '200': description: OK content: application/json: schema: type: object properties: PO_KEY: type: string PO_PONO: type: string PO_DATE: type: string PO_CREATED_FROM_BC: type: string PO_LNNUM: type: string /{alias}/wolines: get: operationId: readWoLinesFromBarcode summary: Read WO lines from barcode tags: - Handheld description: Read WO lines from barcode parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: true schema: type: string maxLength: 14 description: Work Order barcode responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/wo: get: operationId: readWoHeaderFromBarcode summary: Read WO header from barcode tags: - Handheld description: Read WO header from barcode parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: true schema: type: string maxLength: 14 description: Work Order barcode responses: '200': description: OK content: application/json: schema: type: object properties: WOH_CODIV: type: string WOH_WHSE: type: string WOH_ORDNO: type: string WOH_NUMBER: type: string WOH_STATUS: type: string WOH_CREATED_USER: type: string WOH_CREATED_DATE: type: string WOH_CREATED_TIME: type: string WOH_CHG_USER: type: string WOH_CHG_DATE: type: string WOH_CHG_TIME: type: string WOH_INSTALL_SEQ: type: string WOH_INSTALL_LNNUM: type: string WOH_INSTALL_DATE: type: string WOH_MODE: type: string WOH_REVISION_NAME: type: string WOH_INSTALL_AMOUNT: type: string WOH_REVISION_NUMBER: type: string WOH_INSTALL_LABOR_CODE: type: string STATUS: type: string /{alias}/assign: patch: operationId: unassignInventory summary: Unassign Inventory tags: - Handheld description: Unassign Inventory parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: false schema: type: string maxLength: 6 description: Job number - REQUIRED when bo is not sent. When both bo and job are filled job will be used. - name: bo in: query required: false schema: type: string maxLength: 6 description: Build order number - REQUIRED when job is not sent. When both bo and job are filled job will be used. - name: lnnum in: query required: true schema: type: string maxLength: 3 description: Line number being unassigned. - name: invpoint in: query required: true schema: type: string maxLength: 36 description: Full inventory pointer key responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string post: operationId: assignInventory summary: Assign Inventory tags: - Handheld description: Assign Inventory parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. job: type: string maxLength: 6 description: REQUIRED when bo is not sent. When both bo and job are filled job will be used. bo: type: string maxLength: 6 description: REQUIRED when job is not sent. When both bo and job are filled job will be used. lnnum: type: string maxLength: 3 description: Line number being unassigned. barcode: type: string maxLength: 36 description: Item barcode. box: type: string maxLength: 1 description: Used when assigning by box. quantity: type: string maxLength: 15 description: Used when specifying a quantity other than full quantity available. required: - company - branch - lnnum - barcode - quantity responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/ship: post: operationId: shipsWorkOrder summary: Ships Work Order tags: - Handheld description: Ships Work Order and creates a shipped revision parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. barcode: type: string maxLength: 14 description: Work order number with revision. ordstatuscode: type: string maxLength: 10 description: Optional required: - company - branch - barcode responses: '200': description: OK content: application/json: schema: type: object properties: WOH_CODIV: type: string WOH_WHSE: type: string WOH_ORDNO: type: string WOH_NUMBER: type: string WOH_STATUS: type: string WOH_CREATED_USER: type: string WOH_CREATED_DATE: type: string WOH_CREATED_TIME: type: string WOH_CHG_USER: type: string WOH_CHG_DATE: type: string WOH_CHG_TIME: type: string WOH_INSTALL_SEQ: type: string WOH_INSTALL_LNNUM: type: string WOH_INSTALL_DATE: type: string WOH_MODE: type: string WOH_REVISION_NAME: type: string WOH_INSTALL_AMOUNT: type: string WOH_REVISION_NUMBER: type: string WOH_INSTALL_LABOR_CODE: type: string STATUS: type: string /{alias}/hhgetlocations: get: operationId: inventoryLocationsFromBarcodeScan summary: Inventory Locations from barcode scan tags: - Handheld description: Inventory locations barcode scan parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: true schema: type: string maxLength: 14 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/unpicked: get: operationId: getUnpickedInventory summary: Get unpicked inventory tags: - Handheld description: Get unpicked inventory parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: invkey in: query required: true schema: type: string maxLength: 30 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/inventorycomments: get: operationId: getInventoryComments summary: Get inventory comments tags: - Handheld description: Get inventory comments parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/tempbarcode: get: operationId: findTemporaryInventoryBarcode summary: Find temporary inventory barcode. tags: - Handheld description: Find temporary inventory barcode. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: false schema: type: string maxLength: 14 responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string TEMP_BARCODE: type: string /{alias}/barcodesettings: get: operationId: getUserBarcodeSettings summary: Get user barcode settings. tags: - Handheld description: Get user barcode settings. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string BRANCH: type: string USER: type: string USER_DEFAULT_BARCODE_BRANCH: type: string USER_WO_IGNORE_SHIP: type: string USER_ALLOW_CHG_INVENTORY: type: string COMPANY_NOT_BOX: type: string /{alias}/stagedrevisions: get: operationId: getStagedRevisionsList summary: Get staged revisions list tags: - Handheld description: Get staged revisions list parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: barcode in: query required: false schema: type: string maxLength: 14 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/convertinvqty: get: operationId: convertInventoryQuantity summary: Convert Inventory Quantity tags: - Handheld description: Convert Inventory Quantity parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: barcode in: query required: true schema: type: string maxLength: 14 description: Catalog or Inevntory barcode. - name: ordlwqty in: query required: false schema: type: string maxLength: 9 - name: box in: query required: false schema: type: string maxLength: 1 description: Send Y when converting box qty to invetory qty. responses: '200': description: OK content: application/json: schema: type: object properties: INVENTORY_QTY: type: string INVENTORY_BOXQTY: type: string /{alias}/purchaseorderlines: get: operationId: readPurchaseOrderLinesThatAreOpen summary: Read purchase order lines that are open tags: - Purchase Order description: Read purchase order lines that are open parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. requestBody: required: true content: application/json: schema: type: object properties: status: type: string maxLength: 1 description: PO Status filter. Defaults to 'blank'. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/purchaseorderheader: get: operationId: purchaseOrderDetail summary: Purchase order detail tags: - Purchase Order description: Purchase order detail parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: ponumber in: query required: true schema: type: string maxLength: 6 description: PO number requested responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string BRANCH: type: string PONUMBER: type: string STATUS: type: string VENDOR: type: string COMMENT: type: string REFNUM: type: string DATE: type: string TERMS: type: string STOPORDER: type: string CONSIGNMENT-COPIED: type: string EXPENSES-ALLOCATED: type: number EST-EXCHG-RATE: type: number EXCHG-FREIGHT: type: number EXCHG-COST1: type: number EXCHG-COST2: type: number EXCHG-COST3: type: number INCLUDE-GROSS-COST: type: number INCLUDE-FREIGHT: type: number INCLUDE-COST1: type: number INCLUDE-COST2: type: number INCLUDE-COST3: type: number ENABLE-EXPANDED-COST: type: number /{alias}/purchaseorderheaders: get: operationId: listOfPurchaseOrdersByDate summary: List of purchase orders by date tags: - Purchase Order description: List of purchase orders by date parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: startdate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: enddate in: query required: true schema: type: string maxLength: 8 description: Format - YYYYMMDD - name: lastdays in: query required: false schema: type: string maxLength: 4 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 in: query required: false schema: type: array items: type: string description: Vendors to filter by - name: status in: query required: false schema: type: array items: type: string description: Status codes to filter by responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string BRANCH: type: string PONUMBER: type: string STATUS: type: string VENDOR: type: string COMMENT: type: string REFNUM: type: string DATE: type: string TERMS: type: string STOPORDER: type: string CONSIGNMENT-COPIED: type: string EXPENSES-ALLOCATED: type: number EST-EXCHG-RATE: type: number EXCHG-FREIGHT: type: number EXCHG-COST1: type: number EXCHG-COST2: type: number EXCHG-COST3: type: number INCLUDE-GROSS-COST: type: number INCLUDE-FREIGHT: type: number INCLUDE-COST1: type: number INCLUDE-COST2: type: number INCLUDE-COST3: type: number ENABLE-EXPANDED-COST: type: number /{alias}/shipvia: get: operationId: poShipvia summary: PO Shipvia tags: - Purchase Order description: PO Shipvia List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/freightterms: get: operationId: poFreightTerms summary: PO Freight Terms tags: - Purchase Order description: PO Freight Terms List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/smop: get: operationId: poShipmentMethodOfPayment summary: PO Shipment Method of Payment tags: - Purchase Order description: PO Shipment Method of Payment List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/vendortypes: get: operationId: vendorTypeList summary: Vendor Type List tags: - Purchase Order description: Venndor Type List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/customertype: get: operationId: customerTypeList summary: Customer Type List tags: - Purchase Order description: Customer Type List parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/ponote: post: operationId: createsAPoNote summary: Creates a PO Note tags: - Purchase Order description: Creates a PO Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. order: type: string maxLength: 6 note: type: string maxLength: 59 required: - company - branch - order - note responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BRANCH: type: string ORDER: type: string PAGE: type: string LINE: type: string NOTE: type: string patch: operationId: editsAPoNote summary: Edits a PO Note tags: - Purchase Order description: Edits a PO Note parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 - name: note in: query required: true schema: type: string maxLength: 59 - name: page in: query required: false schema: type: string maxLength: 2 - name: lnnum in: query required: false schema: type: string maxLength: 2 responses: '200': description: OK content: application/json: schema: type: object properties: CO: type: string BRANCH: type: string ORDER: type: string PAGE: type: string LINE: type: string NOTE: type: string get: operationId: readsPoNotes summary: Reads PO Notes tags: - Purchase Order description: Reads PO Notes parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: order in: query required: true schema: type: string maxLength: 6 - name: page in: query required: false schema: type: string maxLength: 2 - name: lnnum in: query required: false schema: type: string maxLength: 2 responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/polinecomments: post: operationId: createPoLineComment summary: Create PO Line Comment tags: - Purchase Order description: Creates an PO line comment. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: RollMaster company. branch: type: string maxLength: 2 description: RollMaster branch. job: type: string maxLength: 6 lnnum: type: string maxLength: 3 linenote: type: string maxLength: 59 required: - company - branch responses: '200': description: OK content: application/json: schema: type: object properties: POLN_CODIV: type: string POLN_WHSE: type: string POLN_PONO: type: string POLN_LNNUM: type: string POLN_SEQ: type: string POLN_NOTES: type: string get: operationId: getPoLineCommments summary: Get PO line commments tags: - Purchase Order description: Get all PO line commments parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: job in: query required: false schema: type: string maxLength: 6 - name: lnnum in: query required: false schema: type: string maxLength: 3 responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/popointers: get: operationId: getPoPointers summary: Get PO Pointers tags: - Purchase Order description: Get all PO Pointers parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: order in: query required: false schema: type: string maxLength: 6 description: Optional - name: status in: query required: false schema: type: string maxLength: 1 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/pos: get: operationId: getPurchaseOrderFileDataSqlFormat summary: Get Purchase Order File Data - SQL Format tags: - Purchase Order description: Get Purchase Order File Data - SQL Format parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: status in: query required: false schema: type: string maxLength: 1 description: Optional - When neither C (closed) or O (open) is sent only open purchase orders are returned. - name: po in: query required: false schema: type: string maxLength: 6 description: Optional - purchase order number responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/cip_summary: get: operationId: chargeitproSummary summary: ChargeItPro summary tags: - ChargeItPro description: bucket/summary chargeitpro transaction data parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/vendors: get: operationId: vendorDetails summary: Vendor Details tags: - Vendor description: Vendor Details parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: page in: query required: false schema: type: number maxLength: 4 default: '1' description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page. - name: pagelimit in: query required: false schema: type: number maxLength: 4 default: '1000' 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 in: query required: false schema: type: string maxLength: 8 description: Optional - Used to return speciific vendor details - name: term in: query required: false schema: type: string maxLength: 30 description: Optional - Used to search Vendor ID and Name responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/vendorcontacts: get: operationId: getVendorContacts summary: Get Vendor Contacts tags: - Vendor description: Get contact details for a single vendor or multiple vendors parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: vendor in: query required: false schema: type: string maxLength: 8 description: Optional - use to return contact details for a single vendor responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/committed: get: operationId: committedInventory summary: Committed Inventory tags: - Committed description: Stocking items with committed inventory parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/searchbyphone: get: operationId: getRecordsFromTheCustomerCustomerAddressCustomerContactsLeadsAndVendorRecordsBasedOnPhoneNumber summary: Get records from the customer, customer address, customer contacts, leads, and vendor records based on phone number. tags: - General description: Get records from the customer, customer address, customer contacts, leads, and vendor records based on phone number. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: term in: query required: true schema: type: string maxLength: 30 description: Phone number in 111-111-1111 format. responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string BRANCH: type: string ID: type: string RECORD_TYPE: type: string SOURCE: type: string /{alias}/contactcreation: get: operationId: getRecordsForContactsCreatedOnOrAfterDateSent summary: Get records for contacts created on or after date sent. tags: - General description: Get records for contacts created on or after date sent. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: date in: query required: true schema: type: string maxLength: 8 description: Date in YYYYMMDD format. responses: '200': description: OK content: application/json: schema: type: object properties: COMPANY: type: string BRANCH: type: string ID: type: string RECORD_TYPE: type: string SOURCE: type: string CONTACT_FIRST: type: string CONTACT_LAST: type: string CONTACT_EMAIL: type: string CONTACT_BIRTHDAY: type: string CONTACT_PHONE1: type: string CONTACT_PHONE2: type: string CONTACT_CITY: type: string CONTACT_STATE: type: string CONTACT_DEF_EMAIL_LVL: type: string CONTACT_TEXT_UPDATE: type: string CONTACT_CREATED: type: string /{alias}/webstorages: get: operationId: getWebStorageObjectsPerUser summary: Get web storage objects per user tags: - General description: Get web storage objects per user. Used for long term storage of web items that would normally end up in localStorage or Session objects parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: false schema: type: string maxLength: 2 description: Company ID, can be passed as a blank for all companies - name: branch in: query required: false schema: type: string maxLength: 2 description: Branch ID, can be passed as blank or not submitted to return all branches responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/webstorage: get: operationId: getWebStorageObjectsPerUser1 summary: Get web storage objects per user tags: - General description: Get web storage objects per user. Used for long term storage of web items that would normally end up in localStorage or Session objects parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: false schema: type: string maxLength: 2 description: Company ID, can be passed as a blank for all companies - name: branch in: query required: false schema: type: string maxLength: 2 description: Branch ID, can be passed as blank or not submitted to return all branches - name: SETTING in: query required: true schema: type: string maxLength: 100 description: Setting ID, must be unique responses: '200': description: OK content: application/json: schema: type: object properties: WEBSTORAGE_CODIV: type: string WEBSTORAGE_WHSE: type: string WEBSTORAGE_USERID: type: string WEBSTORAGE_SETTING: type: string WEBSTORAGE_VALUE: type: string post: operationId: createWebstorageObject summary: Create webstorage object tags: - General description: Create webstorage object for username, setting, and value. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. requestBody: required: true content: application/json: schema: type: object properties: company: type: string maxLength: 2 description: Company ID branch: type: string maxLength: 2 description: Branch ID SETTING: type: string maxLength: 100 description: Setting ID, must be unique VALUE: type: string maxLength: 2048 required: - SETTING - VALUE responses: '200': description: OK content: application/json: schema: type: object properties: WEBSTORAGE_CODIV: type: string WEBSTORAGE_WHSE: type: string WEBSTORAGE_USERID: type: string WEBSTORAGE_SETTING: type: string WEBSTORAGE_VALUE: type: string patch: operationId: updateWebstorageObject summary: Update webstorage object tags: - General description: Update webstorage object for username, setting, and value. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: false schema: type: string maxLength: 2 description: Company ID - name: branch in: query required: false schema: type: string maxLength: 2 description: Branch ID - name: SETTING in: query required: true schema: type: string maxLength: 100 description: Setting ID, must be unique - name: VALUE in: query required: true schema: type: string maxLength: 2048 responses: '200': description: OK content: application/json: schema: type: object properties: WEBSTORAGE_CODIV: type: string WEBSTORAGE_WHSE: type: string WEBSTORAGE_USERID: type: string WEBSTORAGE_SETTING: type: string WEBSTORAGE_VALUE: type: string delete: operationId: updateWebstorageObject1 summary: Update webstorage object tags: - General description: Update webstorage object for username, setting, and value. parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: false schema: type: string maxLength: 2 description: Company ID - name: branch in: query required: false schema: type: string maxLength: 2 description: Branch ID - name: SETTING in: query required: true schema: type: string maxLength: 100 description: Setting ID, must be unique responses: '200': description: OK content: application/json: schema: type: object properties: WEBSTORAGE_CODIV: type: string WEBSTORAGE_WHSE: type: string WEBSTORAGE_USERID: type: string WEBSTORAGE_SETTING: type: string WEBSTORAGE_VALUE: type: string /{alias}/buildorders: get: operationId: getBmFile summary: Get BM File tags: - Build Order description: Get BM File parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: order in: query required: false schema: type: string maxLength: 6 description: Optional - name: ordstatus in: query required: false schema: type: string maxLength: 1 description: Appending and using I returns closed orders, using A returns open and closed orders. responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/buildorderlines: get: operationId: getBuildOrderLinesFile summary: Get Build Order Lines File tags: - Build Order description: Returns Build Order Lines parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: order in: query required: false schema: type: string maxLength: 6 description: Optional - name: ordstatus in: query required: false schema: type: string maxLength: 1 description: Appending and using I returns closed orders, using A returns open and closed orders. responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/buildorderpoint: get: operationId: getBuildOrderPointFile summary: Get Build Order Point File tags: - Build Order description: Returns Build Order Point Records parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: order in: query required: false schema: type: string maxLength: 6 description: Optional - name: ordstatus in: query required: false schema: type: string maxLength: 1 description: Appending and using I returns closed orders, using A returns open and closed orders. responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/orderrelatedbolines: get: operationId: getOrderRelatedBuildOrderLines summary: Get Order-Related Build Order Lines tags: - Build Order description: Returns order-related build order lines by company, branch, order number, and/or audit date parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: false schema: type: string maxLength: 2 description: Optional - name: order in: query required: false schema: type: string maxLength: 6 description: Optional - name: startdate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - Looks Audit Date in Range. - name: enddate in: query required: false schema: type: string maxLength: 8 description: Format - YYYYMMDD - - Looks Audit Date in Range. - name: ordstatus in: query required: false schema: type: string maxLength: 1 description: Appending and using I returns closed orders, using A returns open and closed orders. responses: '200': description: OK content: application/json: schema: type: object properties: COMMENT: type: array items: type: array items: type: string /{alias}/installerlogo: get: operationId: getInstallerLogo summary: Get Installer Logo tags: - Logo description: Get Installer Logo parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: installer in: query required: false schema: type: string maxLength: 8 description: Optional responses: '200': description: OK content: application/json: schema: type: object properties: LOGO_PATH: type: string /{alias}/getlogo: get: operationId: getLogo summary: Get Logo tags: - Logo description: Get header and footer logo information by company, branch and document type parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: doctype in: query required: false schema: type: string maxLength: 10 description: Required - returns specific logo information for Agreement (O), Invoice (I), or Quote (Q). responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string /{alias}/logosettings: get: operationId: getLogoSettingsBuDocumentType summary: Get Logo settings bu document type tags: - Logo description: Get Logo settings bu document type parameters: - name: alias in: path required: true schema: type: string description: The clientid for the API call. - name: company in: query required: true schema: type: string maxLength: 2 description: RollMaster company. - name: branch in: query required: true schema: type: string maxLength: 2 description: RollMaster branch. - name: doctype in: query required: false schema: type: string maxLength: 10 description: Required - returns specific logo information for Agreement (O), Invoice (I), or Quote (Q). responses: '200': description: OK content: application/json: schema: type: object properties: '0': type: array items: type: string components: securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: API key issued by Broadlume, required on every request. sessionToken: type: apiKey in: header name: token description: User session token obtained from POST /{alias}/token. Sessions expire after a server-specified idle timeout (default 5 minutes); refresh with the keepalive endpoint.