Trendsic Platform Service

<back to all web services

CreateQuoteRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/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 Quote {
    /** @param {{QuoteID?:number,QuoteUID?:string,TenantId?:string,BranchId?:string,ProjectID?:number,ProjectUID?:string,ProjectName?:string,Name?:string,Status?:string,Total?:number,Notes?:string,Currency?:string,FromName?:string,FromPhone?:string,FromEmail?:string,FromAddress?:string,ToName?:string,ToPhone?:string,ToEmail?:string,ToAddress?:string,ExpiresAt?:string,IsLocked?:boolean,FinalPriceAfterCompletion?:boolean,ApprovedByName?:string,ApprovedAt?:string,DeclinedByName?:string,DeclinedAt?:string,DeclineReason?:string,CreatedBy?:string,CreatedAt?:string,UpdatedBy?:string,UpdatedAt?:string,Items?:QuoteItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    QuoteID;
    /** @type {string} */
    QuoteUID;
    /** @type {?string} */
    TenantId;
    /** @type {?string} */
    BranchId;
    /** @type {number} */
    ProjectID;
    /** @type {?string} */
    ProjectUID;
    /** @type {string} */
    ProjectName;
    /** @type {string} */
    Name;
    /** @type {string} */
    Status;
    /** @type {?number} */
    Total;
    /** @type {string} */
    Notes;
    /** @type {string} */
    Currency;
    /** @type {string} */
    FromName;
    /** @type {string} */
    FromPhone;
    /** @type {string} */
    FromEmail;
    /** @type {string} */
    FromAddress;
    /** @type {string} */
    ToName;
    /** @type {string} */
    ToPhone;
    /** @type {string} */
    ToEmail;
    /** @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 {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {string} */
    UpdatedBy;
    /** @type {?string} */
    UpdatedAt;
    /** @type {QuoteItem[]} */
    Items = [];
}
export class QuoteResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Quote?:Quote}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Quote} */
    Quote;
}
export class CreateQuoteRequest {
    /** @param {{Quote?:Quote}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Quote} */
    Quote;
}

JavaScript CreateQuoteRequest 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.

POST /v1/quote HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Quote: 
	{
		QuoteID: 0,
		QuoteUID: 00000000000000000000000000000000,
		TenantId: 00000000000000000000000000000000,
		BranchId: 00000000000000000000000000000000,
		ProjectID: 0,
		ProjectUID: 00000000000000000000000000000000,
		ProjectName: String,
		Name: String,
		Status: String,
		Total: 0,
		Notes: String,
		Currency: String,
		FromName: String,
		FromPhone: String,
		FromEmail: String,
		FromAddress: String,
		ToName: String,
		ToPhone: String,
		ToEmail: 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,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedBy: String,
		UpdatedAt: 0001-01-01,
		Items: 
		[
			{
				QuoteItemID: 0,
				QuoteID: 0,
				ItemType: String,
				SourceRefId: 0,
				JobID: 0,
				Name: String,
				Description: String,
				Quantity: 0,
				UnitPrice: 0,
				IsTaxable: False,
				DisplayOrder: 0,
				IsDeleted: False
			}
		]
	}
}

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
		}
	},
	Quote: 
	{
		QuoteID: 0,
		QuoteUID: 00000000000000000000000000000000,
		TenantId: 00000000000000000000000000000000,
		BranchId: 00000000000000000000000000000000,
		ProjectID: 0,
		ProjectUID: 00000000000000000000000000000000,
		ProjectName: String,
		Name: String,
		Status: String,
		Total: 0,
		Notes: String,
		Currency: String,
		FromName: String,
		FromPhone: String,
		FromEmail: String,
		FromAddress: String,
		ToName: String,
		ToPhone: String,
		ToEmail: 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,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedBy: String,
		UpdatedAt: 0001-01-01,
		Items: 
		[
			{
				QuoteItemID: 0,
				QuoteID: 0,
				ItemType: String,
				SourceRefId: 0,
				JobID: 0,
				Name: String,
				Description: String,
				Quantity: 0,
				UnitPrice: 0,
				IsTaxable: False,
				DisplayOrder: 0,
				IsDeleted: False
			}
		]
	}
}