POST api/Document/Quote/ProForma/{id}?isThirdParty={isThirdParty}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
|
| isThirdParty | boolean |
Required |
Body Parameters
DocumentAddViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| HeaderLogo | LogoViewModel |
None. |
|
| FooterLogo | LogoViewModel |
None. |
|
| IncludeHeader | boolean |
None. |
|
| ShowQuoteCreationDate | boolean |
None. |
|
| BillingCompany | CustomerFindListItem |
None. |
|
| BillingContact | ContactFindListItem |
None. |
|
| BillingLocation | LocationFindListItem |
None. |
|
| LineItemPrintingOptions | LineItemPrintingOptions |
None. |
|
| SummaryPrintingOptions | SummaryPrintingOptions |
None. |
|
| Sections | Collection of SectionViewModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"headerLogo": {
"logoID": 1,
"name": "sample string 2",
"fileName": "sample string 3",
"info": "sample string 4"
},
"footerLogo": {
"logoID": 1,
"name": "sample string 2",
"fileName": "sample string 3",
"info": "sample string 4"
},
"includeHeader": true,
"showQuoteCreationDate": true,
"billingCompany": {
"customerID": 1,
"locationID": 2,
"company": "sample string 3",
"address1": "sample string 4",
"address2": "sample string 5",
"city": "sample string 6",
"state": "sample string 7",
"zip": "sample string 8",
"phone": "sample string 9"
},
"billingContact": {
"contactID": 1,
"locationID": 2,
"name": "sample string 3",
"title": "sample string 4",
"email": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"ext": "sample string 8",
"isPrimary": true
},
"billingLocation": {
"locationID": 1,
"description": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"isPrimary": true
},
"lineItemPrintingOptions": {
"printColorOptions": true,
"printLineItems": true,
"showDiscounts": true,
"printSubComponents": true,
"printLineItemTotals": true,
"printPriceList": true,
"printSellingList": true
},
"summaryPrintingOptions": {
"printSubTotal": true,
"printFreight": true,
"printManufacturersSeparately": true,
"printTax": true,
"printMaterialSurcharge": true,
"printDiscount": true,
"printGrant": true,
"printCWOSeparately": true,
"printContractSeparately": true
},
"sections": [
{
"sectionID": 1,
"name": "sample string 2",
"details": "sample string 3",
"editedDetails": "sample string 4",
"editable": true,
"viewable": true,
"isGameTime": true,
"isSelected": true,
"doesReplaceUser": true,
"doesReplacePrice": true
},
{
"sectionID": 1,
"name": "sample string 2",
"details": "sample string 3",
"editedDetails": "sample string 4",
"editable": true,
"viewable": true,
"isGameTime": true,
"isSelected": true,
"doesReplaceUser": true,
"doesReplacePrice": true
}
]
}
application/xml, text/xml
Sample:
<DocumentAddViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GameTimeBAL.ViewModels">
<IncludeHeader>false</IncludeHeader>
<LineItemPrintingOptions>
<PrintColorOptions>true</PrintColorOptions>
<PrintLineItemTotals>true</PrintLineItemTotals>
<PrintLineItems>true</PrintLineItems>
<PrintPriceList>true</PrintPriceList>
<PrintSellingList>true</PrintSellingList>
<PrintSubComponents>true</PrintSubComponents>
<ShowDiscounts>true</ShowDiscounts>
</LineItemPrintingOptions>
<Sections>
<SectionViewModel>
<Details>sample string 3</Details>
<DoesReplacePrice>true</DoesReplacePrice>
<DoesReplaceUser>true</DoesReplaceUser>
<Editable>true</Editable>
<EditedDetails>sample string 4</EditedDetails>
<IsGameTime>true</IsGameTime>
<IsSelected>true</IsSelected>
<Name>sample string 2</Name>
<SectionID>1</SectionID>
<Viewable>true</Viewable>
</SectionViewModel>
<SectionViewModel>
<Details>sample string 3</Details>
<DoesReplacePrice>true</DoesReplacePrice>
<DoesReplaceUser>true</DoesReplaceUser>
<Editable>true</Editable>
<EditedDetails>sample string 4</EditedDetails>
<IsGameTime>true</IsGameTime>
<IsSelected>true</IsSelected>
<Name>sample string 2</Name>
<SectionID>1</SectionID>
<Viewable>true</Viewable>
</SectionViewModel>
</Sections>
<SummaryPrintingOptions>
<PrintCWOSeparately>true</PrintCWOSeparately>
<PrintContractSeparately>true</PrintContractSeparately>
<PrintDiscount>true</PrintDiscount>
<PrintFreight>true</PrintFreight>
<PrintGrant>true</PrintGrant>
<PrintManufacturersSeparately>true</PrintManufacturersSeparately>
<PrintMaterialSurcharge>true</PrintMaterialSurcharge>
<PrintSubTotal>true</PrintSubTotal>
<PrintTax>true</PrintTax>
</SummaryPrintingOptions>
<BillingCompany>
<Address1>sample string 4</Address1>
<Address2>sample string 5</Address2>
<City>sample string 6</City>
<Company>sample string 3</Company>
<CustomerID>1</CustomerID>
<LocationID>2</LocationID>
<Phone>sample string 9</Phone>
<State>sample string 7</State>
<Zip>sample string 8</Zip>
</BillingCompany>
<BillingContact>
<ContactID>1</ContactID>
<Email>sample string 5</Email>
<Ext>sample string 8</Ext>
<Fax>sample string 7</Fax>
<IsPrimary>true</IsPrimary>
<LocationID>2</LocationID>
<Name>sample string 3</Name>
<Phone>sample string 6</Phone>
<Title>sample string 4</Title>
</BillingContact>
<BillingLocation>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<City>sample string 5</City>
<Description>sample string 2</Description>
<IsPrimary>true</IsPrimary>
<LocationID>1</LocationID>
<State>sample string 6</State>
<Zip>sample string 7</Zip>
</BillingLocation>
<FooterLogo>
<FileName>sample string 3</FileName>
<Info>sample string 4</Info>
<LogoID>1</LogoID>
<Name>sample string 2</Name>
</FooterLogo>
<HeaderLogo>
<FileName>sample string 3</FileName>
<Info>sample string 4</Info>
<LogoID>1</LogoID>
<Name>sample string 2</Name>
</HeaderLogo>
<IncludeHeader>true</IncludeHeader>
<ShowQuoteCreationDate>true</ShowQuoteCreationDate>
</DocumentAddViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.