Create a proposal
Creates a proposal and returns its ID in the response. Once a proposal is created via API, an email is sent to the addressees listed in the notificationEmails parameter and a proposal appears in the ServiceChannel system. Use the response model of the GET /proposals/CheckProposalCreation method as a request model. <br />Note: To run the method, subscriber users should possess one or a combination of the following permissions and roles: Proposals: Create permission, * Proposals:Full Control* permission, Power User role, Power User Light role. When provider users are eligible to create proposals via UI, they can also create proposals via API. Find out more about creating a proposal in ServiceChannel University. <br /> Note: Custom proposal forms are not supported. <br />Example Request
POST /proposals/CreateProposal
{
"version": "1.0.0",
"subscriberId": 2014917243,
"providerId": 2000090505,
"locationId": 2016322567,
"tradeId": 90480,
"currency": "USD",
"proposalNumber": "pr57820456142079",
"description": "Motor Replacement",
"notificationEmails": "",
"costsIncurredToDate": [],
"materials": [
{"description": "Motor Assembly Unit", "unit": "each", "qty": 1, "price": 1450.00},
{"description": "Electrical Components Kit", "unit": "each", "qty": 1, "price": 180.50},
{ "description": "Fan Blade Component", "unit": "each", "qty": 1, "price": 320.75},
{ "description": "Capacitor Unit", "unit": "each", "qty": 1, "price": 95.25}
],
"materialsAnswer": "New",
"installationLabor": [
{"description": "Regular Service Hours", "tech": 1, "hours": 10, "rate": 95.00},
{ "description": "Overtime Service Hours", "tech": 0, "hours": 0, "rate": 0},
{ "description": "Holiday Service Hours", "tech": 0, "hours": 0, "rate": 0},
{ "description": "Helper Standard Hours", "tech": 0, "hours": 0, "rate": 0},
{ "description": "Helper Overtime Hours", "tech": 0, "hours": 0, "rate": 0},
{ "description": "Helper Holiday Hours", "tech": 0, "hours": 0, "rate": 0},
{ "description": "External Labor Support", "tech": 0, "hours": 0, "rate": 0}
],
"installationLaborFlatFeeLabor": 0,
"nonInstallationExpenses": {
"travel": { "ofTrips": 2, "charge": 85.00},
"fees": 0,
"nonInstallationLabor": 0
},
"nonInstallationExpensesOther": [],
"freight": 140.00,
"freightOther": [],
"tax": {
"materialSalesTax": 0,
"installationLaborSalesTax": 0,
"nonInstallationExpensesSalesTax": 0,
"freightTax": 0
}
}
Request
- Base URLhttps://sb2api.servicechannel.com/v3
- AuthOAuth 2Authorization codehttps://sb2login.servicechannel.com/oauth/authorizeToken URLhttps://sb2login.servicechannel.com/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
A proposal is successfully created.
Changes
No recorded changes to this operation across all 1 revision of this API.