Trendsic Platform Service

<back to all web services

PortalQuoteRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/quote
"use strict";
export class QuoteItem {
    /** @param {{QuoteItemID?:number,QuoteID?:number,ItemType?:string,SourceRefId?:number,JobID?:number,Name?:string,Description?:string,Quantity?:number,UnitPrice?:number,IsTaxable?:boolean,DisplayOrder?:number,IsDeleted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    QuoteItemID;
    /** @type {number} */
    QuoteID;
    /** @type {string} */
    ItemType;
    /** @type {?number} */
    SourceRefId;
    /** @type {?number} */
    JobID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {?number} */
    Quantity;
    /** @type {?number} */
    UnitPrice;
    /** @type {?boolean} */
    IsTaxable;
    /** @type {?number} */
    DisplayOrder;
    /** @type {?boolean} */
    IsDeleted;
}
export class PortalQuoteResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Name?:string,Status?:string,Currency?:string,Total?:number,Notes?:string,FromName?:string,FromAddress?:string,ToName?:string,ToAddress?:string,ExpiresAt?:string,IsLocked?:boolean,FinalPriceAfterCompletion?:boolean,ApprovedByName?:string,ApprovedAt?:string,DeclinedByName?:string,DeclinedAt?:string,DeclineReason?:string,LineItems?:QuoteItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {string} */
    Name;
    /** @type {string} */
    Status;
    /** @type {string} */
    Currency;
    /** @type {number} */
    Total;
    /** @type {string} */
    Notes;
    /** @type {string} */
    FromName;
    /** @type {string} */
    FromAddress;
    /** @type {string} */
    ToName;
    /** @type {string} */
    ToAddress;
    /** @type {?string} */
    ExpiresAt;
    /** @type {boolean} */
    IsLocked;
    /** @type {boolean} */
    FinalPriceAfterCompletion;
    /** @type {string} */
    ApprovedByName;
    /** @type {?string} */
    ApprovedAt;
    /** @type {string} */
    DeclinedByName;
    /** @type {?string} */
    DeclinedAt;
    /** @type {string} */
    DeclineReason;
    /** @type {QuoteItem[]} */
    LineItems = [];
}
export class PortalQuoteRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

JavaScript PortalQuoteRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /portal/{Token}/quote HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Name: String,
	Status: String,
	Currency: String,
	Total: 0,
	Notes: String,
	FromName: String,
	FromAddress: String,
	ToName: String,
	ToAddress: String,
	ExpiresAt: 0001-01-01,
	IsLocked: False,
	FinalPriceAfterCompletion: False,
	ApprovedByName: String,
	ApprovedAt: 0001-01-01,
	DeclinedByName: String,
	DeclinedAt: 0001-01-01,
	DeclineReason: String,
	LineItems: 
	[
		{
			QuoteItemID: 0,
			QuoteID: 0,
			ItemType: String,
			SourceRefId: 0,
			JobID: 0,
			Name: String,
			Description: String,
			Quantity: 0,
			UnitPrice: 0,
			IsTaxable: False,
			DisplayOrder: 0,
			IsDeleted: False
		}
	]
}