| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CreateQuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Quote>
<ApprovedAt>0001-01-01T00:00:00</ApprovedAt>
<ApprovedByName>String</ApprovedByName>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<Currency>String</Currency>
<DeclineReason>String</DeclineReason>
<DeclinedAt>0001-01-01T00:00:00</DeclinedAt>
<DeclinedByName>String</DeclinedByName>
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<FinalPriceAfterCompletion>false</FinalPriceAfterCompletion>
<FromAddress>String</FromAddress>
<FromEmail>String</FromEmail>
<FromName>String</FromName>
<FromPhone>String</FromPhone>
<IsLocked>false</IsLocked>
<Items>
<QuoteItem>
<Description>String</Description>
<DisplayOrder>0</DisplayOrder>
<IsDeleted>false</IsDeleted>
<IsTaxable>false</IsTaxable>
<ItemType>String</ItemType>
<JobID>0</JobID>
<Name>String</Name>
<Quantity>0</Quantity>
<QuoteID>0</QuoteID>
<QuoteItemID>0</QuoteItemID>
<SourceRefId>0</SourceRefId>
<UnitPrice>0</UnitPrice>
</QuoteItem>
</Items>
<Name>String</Name>
<Notes>String</Notes>
<ProjectID>0</ProjectID>
<ProjectName>String</ProjectName>
<ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
<QuoteID>0</QuoteID>
<QuoteUID>00000000-0000-0000-0000-000000000000</QuoteUID>
<Status>String</Status>
<TenantId>00000000-0000-0000-0000-000000000000</TenantId>
<ToAddress>String</ToAddress>
<ToEmail>String</ToEmail>
<ToName>String</ToName>
<ToPhone>String</ToPhone>
<Total>0</Total>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<UpdatedBy>String</UpdatedBy>
</Quote>
</CreateQuoteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Quote>
<ApprovedAt>0001-01-01T00:00:00</ApprovedAt>
<ApprovedByName>String</ApprovedByName>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<Currency>String</Currency>
<DeclineReason>String</DeclineReason>
<DeclinedAt>0001-01-01T00:00:00</DeclinedAt>
<DeclinedByName>String</DeclinedByName>
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<FinalPriceAfterCompletion>false</FinalPriceAfterCompletion>
<FromAddress>String</FromAddress>
<FromEmail>String</FromEmail>
<FromName>String</FromName>
<FromPhone>String</FromPhone>
<IsLocked>false</IsLocked>
<Items>
<QuoteItem>
<Description>String</Description>
<DisplayOrder>0</DisplayOrder>
<IsDeleted>false</IsDeleted>
<IsTaxable>false</IsTaxable>
<ItemType>String</ItemType>
<JobID>0</JobID>
<Name>String</Name>
<Quantity>0</Quantity>
<QuoteID>0</QuoteID>
<QuoteItemID>0</QuoteItemID>
<SourceRefId>0</SourceRefId>
<UnitPrice>0</UnitPrice>
</QuoteItem>
</Items>
<Name>String</Name>
<Notes>String</Notes>
<ProjectID>0</ProjectID>
<ProjectName>String</ProjectName>
<ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
<QuoteID>0</QuoteID>
<QuoteUID>00000000-0000-0000-0000-000000000000</QuoteUID>
<Status>String</Status>
<TenantId>00000000-0000-0000-0000-000000000000</TenantId>
<ToAddress>String</ToAddress>
<ToEmail>String</ToEmail>
<ToName>String</ToName>
<ToPhone>String</ToPhone>
<Total>0</Total>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<UpdatedBy>String</UpdatedBy>
</Quote>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</QuoteResponse>