Quote Listing JSON

Have more questions? Submit a request

The purpose of this document is to cover Quote Listings using JSON. The following areas will be covered:

  • Quote Listing Fields
  • Find Fields Function

Requirements:

  • Users must have O4. To learn more about moving forward with O4, email OASIS Sales at sales@oasissalessoftware.com or 501-843-6750.
  • Users must create bearer tokens in O4 to authorize the call in an external API software.

 

Quote Listing Fields - JSON

JSON is used to retrieve/display the fields within the "Quote Listing" segment. 

A group of JSON APIs perform the OASIS function of searching in one of the OASIS applications using the "Find" feature and showing the columns available in the "Preferences" feature.

To retrieve a list of all "Quote Listing" fields and "Find" searchable fields, use the following URL:

https://{BASE_URL}/API?ajax=QuoteListing&help=all

 

OASIS Website Interface Information:

https://{BASE_URL}/API?

The BASE_URL is the O4 URL provided by OASIS.

The BASE_URL consists of {web address/environment}

What OASIS application information is being looked up:

ajax=QuoteListing

What OASIS application information is being Returned: 

&help=all (will retrieve and display all fields in the OASIS application - Quote Listing)

 

Sample URL:

https://{BASE_URL}/API? ajax=QuoteListing&help=all

Note:  this call will return all QuoteListing fields and Find fields from the OASIS application of "QuoteListing"

 

Below are the "Quote Listing" field names and their type. 

Name Type Definition
Project Text Project ID
Location Text Location of the Quote
LocationState Text State where the Quote is located

Bill

Text Billing Name for Quote
BillDate Date Date of Billing for Quote
RADate Date Request for Approval Date
BillName Text Billing Address Name
BillLine1 Text Billing Address Line 1
BillLine2 Text Billing Address Line 2
BillCity Text Billing Address City
BillState Text Billing Address State
BillZip Text Billing Address Zip Code
BillCountry Text Billing Address Country
BillCounty Text Billing Address County
CreateDate Date Creation Date of Quote
CreateTerritoryID Text Workgroup ID of Quote Creator 
CreateUser Text User who created Quote
DBID Text Database Identifier
ExpirationDate Text Expiration date of the quote
FileCode Text Reference code for external storage
FileDate Date Date Quote was filed externally
InternalNotes Text Notes visible to OASIS users only
LockedBy Text ID of user responsible for locked status of quote
QuoteID Text Quote Identifier
QuoteLocked Text Quote Locked status
QuoteNotes Text

Customer-facing notes on a Quote

QuoteYear Text Year of Quote
Remarks Text Remarks on the Quote Notes tab
ShipName Text Shipping Address Name
ShipLine1 Text Shipping Address Line 1
ShipLine2 Text Shipping Address Line 2
ShipCity Text Shipping Address City
ShipState Text Shipping Address State
ShipZip Text Shipping Address Zip Code
ShipMark Text Shipping Address ?
Specialization Text Internal use only
VerticalMarket Text User set field denoting the vertical market of the quote to the company
BSID Text Buy/sell identifier
Representatives Text Representative(s) of the quote
CustomerID Text Customer - ID
Spec Registered Text Y = (Out of territory spec registration)
Contractor Assigned To Text Assigned person to the Contractor of the Quote on Order
Status Text Current Status of Quote
Sell Price Currency Price quoted for the Customer
Sell Comm Currency Commission amount or percentage for the sell price
Sell Over Currency Overage amount or percentage for the sell price
Sell Profit Currency Profit amount or percentage for the sell price
Sell Earn Currency Earnings amount or percentage for the sell price
Quoter Text Person who is quoting the job/phase
CSR Text Customer Service Representative 
Specifiers Text Specified persons with customizable roles assigned to a Quote
Contractor Text Contractor on quote
QuoteNumber Text Number of quote
QuoteType Text Denotes the type of quote
Accounts Text Sales accounts on phase
UpdateDate Date Date of last update made to Quote
UpdateUser Text Identity of user who made last update to Quote
Last Attachment Date Date Date of last attachment added to Quote
Last Snapshot Date Date Last major change to quote (For instance, Quote printed and sent to customer)
Owner Text Business or person who owns the job site
Start Date Date Date user estimates job will begin
Original Bid Date Date Original (first) date of bid
Completion Date Date Date the project is estimated to be complete
Valuation Currency User estimated value of the job
Specified Project Text Were items represented by this company specified on the project
Important Project Text Designation of importance status
External Project Number Text Denotes the external website's identifier for this job
Project Rank Text Rank of project related to order
Phase Text Phase of the project
Agencies Text Agencies associated with the order
Customers Text Customer(s) of the job
PAT Valuation Currency Machine Learning estimate of project valuation (requires users to fill out the project valuation fields)
Alias Text Alternate name quote is known by

Note: fields such as KEY Long MFG Field, are user "Search Keys" and can be setup by the user and will appear as KEY $, where $ is whatever they setup. PAT means Prediction Analysis Tool

 

Find Fields Function - JSON

To find a specific "Quote Listing" field(s), use the JSON "Find" function.

A group of JSON APIs perform the common OASIS function of searching in one of the OASIS applications using the "Find" feature and showing the columns available in the "Preferences" feature.

The result will be an object with an array with each returned row under the key "Listing" as found in the URL below:

http://{BASE_URL}/API? ajax=QuoteListing&Quote=123&Listing=Quote,Status,Total%20Price

 

OASIS Website Interface Information:

https://{BASE_URL}/API?

The BASE_URL is the O4 URL provided by OASIS.

The BASE_URL consists of {web address/environment}

What OASIS application information is being looked up:

ajax=QuoteListing&Quote=123

What OASIS application information is being Returned: 

Listing= Quote,Status,Total%20Price

 

Sample URL:

http://{BASE_URL}/API? ajax=QuoteListing&Listing=Quote,Status,Total%20Price

 

Below are the "Quote Listing" find fields (name) and the caption (name returned). 

Method

Name

Caption

Definition

SQL

Project Project Name of related project

SQL

Location Location Location of project

SQL

LocationState LocationState State where project is located

SQL

Quote Quote Quote

SQL

MFGQuote MFGQuote Manufacturer quote values on quote

SQL

PartNumber PartNumber Part Numbers on the quote

SQL

FixtureType FixtureType Item fixture type

SQL

ExternalCode ExternalCode Reference code for use by software outside OASIS

SQL

FileCode FileCode Reference code for physical external storage

SQL

CreateDate CreateDate Creation date of quote

SQL

UpdateDate UpdateDate Date of last update for the quote

SQL

BidDate BidDate Date quote is being bid on

SQL

BlankBidDate BlankBidDate Bid date absent for quote

SQL

OriginalBidDate OriginalBidDate Original (first) date quote is being bid on

SQL

ExpirationDate ExpirationDate Date quote validity expires

SQL

Active Active Active status of quote 

SQL

Inactive Inactive Inactive status of quote

SQL

Specified Specified Specified status of quote

SQL

Important Important Important status of quote

SQL

NationalAccount NationalAccount National Account status of quote

SQL

SpecRegistration SpecRegistration Spec Registration status of quote

SQL

BidBoard BidBoard Quote is checked to appear on bid board

SQL

Rank Rank Rank of quote

SQL

QuoteStatus Quote Status Current status of quote

SQL

VerticalMarket Vertical Market User-set field denoting the Vertical Market of the quote to the company

SQL

DailyQuote Daily Quote Daily Quote status 

SQL

(Simple)Quote (Simple)Quote (Simple) Quote status 

SQL

ProjectBid Project Bid Project Bid status of quote
Calculated MinSell Min Sell Minimum Sell Price of quote
Calculated MinSellEarnings Min Sell Earnings Minimum Earnings of quote
Calculated MinLevel1 Min Level1 Minimum Level1 Sell Price of quote
Calculated MinLevel1Earnings Min Level1 Earnings Minimum Level1 Earnings of quote
Calculated MinLevel2 Min Level2 Minimum Level2 Sell Price of quote
Calculated MinLevel2Earnings Min Level2 Earnings Minimum Level2 Earnings  of quote
Calculated MinLevel3 Min Level3 Minimum Level3 Sell Price of Quote
Calculated MinLevel3Earnings Min Level3 Earnings Minimum Level3 Earnings of Quote
Calculated MaxSell Max Sell Maximum Sell Price of Quote
Calculated MaxSellEarnings Max Sell Earnings Maximum Earnings of Quote
Calculated MaxLevel1 Max Level1 Minimum Level1 Sell Price of Quote
Calculated MaxLevel1Earnings Max Level1 Earnings Maximum Level1 Earnings of Quote
Calculated MaxLevel2 Max Level2 Minimum Level2 Sell Price of Quote
Calculated MaxLevel2Earnings Max Level2 Earnings Maximum Level2 Earnings of Quote
Calculated MaxLevel3 Max Level3 Minimum Level3 Sell Price of Quote
Calculated MaxLevel3Earnings Max Level3 Earnings Maximum Level3 Earnings of Quote

SQL

Quoter Quoter Person who created the quote

SQL

SalesAccount Sales Account Sales Account assigned to quote

SQL

NoSalesAccount No Sales Account No Sales Account assigned to Quote

SQL

SalesAccountsNot100% Sales Accounts Not 100% Sales Account credit less than 100% assigned

SQL

CSR CSR CSR assigned to quote

SQL

CustomerAssignedTo Customer Assigned To Assigned person to the customer on the quote

SQL

ContractorAssignedTo Contractor Assigned To Assigned person to the contractor on the quote

SQL

AssignedFollowUp Assigned Follow Up Follow up person assigned to quote

SQL

Workgroup Workgroup Workgroup assigned to quote

SQL

Locked Locked Locked status of quote

SQL

Manufacturer Manufacturer Manufacturer assigned to quote

SQL

ParentManufacturer Parent Manufacturer Parent manufacturer assigned to quote

SQL

Customer Customer Customer assigned to quote

SQL

ParentCustomer Parent Customer Parent Customer assigned to quote

SQL

Contractor Contractor Contractor assigned to quote

SQL

Representative Representative Representative(s) assigned to quote

SQL

HasSubmittal Has Submittal Quote has submittal 

SQL

NoSubmittal No Submittal Quote does not have submittal

SQL

PriorApproval Prior Approval Prior approval required 

SQL

RADate RA Date Request for approval date range

SQL

SubmittedOn Submitted On Submittal submitted on date range

SQL

Specifiers Specifiers Specifiers field

SQL

Influences Influences Influences field

SQL

SpecifierRole Specifier Role Role of specifier

SQL

Specifier Specifier Selected specifier(s) for quote

SQL

CustomerAssignedSales Customer Assigned Sales Sales account assigned to customer

SQL

QuoteAssignedSales Quote Assigned Sales Sales Account assigned to quote

SQL

HasSpecifier Has Specifier Quote has specifier(s)

SQL

NoSpecifier No Specifier Quote has no specifier(s)

SQL

UnknownSpecifier Unknown Specifier Unknown status of specifier(s)

SQL

LowGC Low GC Lowest general contractor according to price

SQL

LowEC Low EC Lowest electrical contractor according to price

SQL

LowDistributor Low Distributor Lowest distributor according to price

SQL

Notes Notes Customer facing notes

SQL

InternalNotes Internal Notes Notes internal to OASIS

SQL

AttDescription Attachment Description Description of attachment(s)

SQL

AttNote Attachment Note Note regarding attachment(s)

SQL

AttColor Attachment Color User-specified color coding of attachment title(s)

SQL

AttCategory Attachment Category User-specified category of attachment(s) 

 

Note: method of "SQL" is a static/hard query and runs quickly. Method of "calculated" will run through every transaction and takes a lot longer.

Note: in the "Name" column, if there is a space between two words, that infers that "%20" needs to go between the two words. Ex: Total Price = Total%20Price. 

 

Articles in this section

Was this article helpful?
0 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.