Create (submit) a proposal
curl --request POST \
--url https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"workOrderId": 123,
"totalAfterTax": "<string>",
"id": 123,
"scope": "<string>",
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"taxRate": "<string>",
"tax": "<string>",
"totalBeforeTax": "<string>",
"laborTaxRate": "<string>",
"laborTax": "<string>",
"laborTotalBeforeTax": "<string>",
"laborLineItems": [
{
"numberOfTech": 123,
"seconds": 123,
"description": "<string>",
"roleType": "<string>",
"laborType": "<string>",
"hourlyRate": "<string>",
"amount": "<string>"
}
],
"materialTaxRate": "<string>",
"materialTax": "<string>",
"materialTotalBeforeTax": "<string>",
"materialLineItems": [
{
"unitType": "<string>",
"quantity": "<string>",
"description": "<string>",
"partNumber": "<string>",
"partId": 123,
"equipmentNumber": "<string>",
"equipmentId": 123,
"unitPrice": "<string>",
"amount": "<string>"
}
],
"travelTaxRate": "<string>",
"travelTax": "<string>",
"travelTotalBeforeTax": "<string>",
"travelLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"freightTaxRate": "<string>",
"freightTax": "<string>",
"freightTotalBeforeTax": "<string>",
"freightLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"miscTaxRate": "<string>",
"miscTax": "<string>",
"miscTotalBeforeTax": "<string>",
"miscLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"incurredCostTotalBeforeTax": "<string>",
"incurredCostLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"proposalPdfLink": "<string>",
"declineNotes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": true
}
],
"requestForProposalId": 123,
"isAiParsed": true,
"isAiParsedEdited": true,
"aiParseMismatchSignedByEmail": "<string>"
}
'import requests
url = "https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals"
payload = {
"workOrderId": 123,
"totalAfterTax": "<string>",
"id": 123,
"scope": "<string>",
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"taxRate": "<string>",
"tax": "<string>",
"totalBeforeTax": "<string>",
"laborTaxRate": "<string>",
"laborTax": "<string>",
"laborTotalBeforeTax": "<string>",
"laborLineItems": [
{
"numberOfTech": 123,
"seconds": 123,
"description": "<string>",
"roleType": "<string>",
"laborType": "<string>",
"hourlyRate": "<string>",
"amount": "<string>"
}
],
"materialTaxRate": "<string>",
"materialTax": "<string>",
"materialTotalBeforeTax": "<string>",
"materialLineItems": [
{
"unitType": "<string>",
"quantity": "<string>",
"description": "<string>",
"partNumber": "<string>",
"partId": 123,
"equipmentNumber": "<string>",
"equipmentId": 123,
"unitPrice": "<string>",
"amount": "<string>"
}
],
"travelTaxRate": "<string>",
"travelTax": "<string>",
"travelTotalBeforeTax": "<string>",
"travelLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"freightTaxRate": "<string>",
"freightTax": "<string>",
"freightTotalBeforeTax": "<string>",
"freightLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"miscTaxRate": "<string>",
"miscTax": "<string>",
"miscTotalBeforeTax": "<string>",
"miscLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"incurredCostTotalBeforeTax": "<string>",
"incurredCostLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"proposalPdfLink": "<string>",
"declineNotes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": True,
"readOnlyAccess": True,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": True,
"readOnlyAccess": True,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": True,
"readOnlyAccess": True,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": True
}
],
"requestForProposalId": 123,
"isAiParsed": True,
"isAiParsedEdited": True,
"aiParseMismatchSignedByEmail": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workOrderId: 123,
totalAfterTax: '<string>',
id: 123,
scope: '<string>',
attachments: [{fileName: '<string>', fileId: '<string>'}],
taxRate: '<string>',
tax: '<string>',
totalBeforeTax: '<string>',
laborTaxRate: '<string>',
laborTax: '<string>',
laborTotalBeforeTax: '<string>',
laborLineItems: [
{
numberOfTech: 123,
seconds: 123,
description: '<string>',
roleType: '<string>',
laborType: '<string>',
hourlyRate: '<string>',
amount: '<string>'
}
],
materialTaxRate: '<string>',
materialTax: '<string>',
materialTotalBeforeTax: '<string>',
materialLineItems: [
{
unitType: '<string>',
quantity: '<string>',
description: '<string>',
partNumber: '<string>',
partId: 123,
equipmentNumber: '<string>',
equipmentId: 123,
unitPrice: '<string>',
amount: '<string>'
}
],
travelTaxRate: '<string>',
travelTax: '<string>',
travelTotalBeforeTax: '<string>',
travelLineItems: [{description: '<string>', amount: '<string>'}],
freightTaxRate: '<string>',
freightTax: '<string>',
freightTotalBeforeTax: '<string>',
freightLineItems: [{description: '<string>', amount: '<string>'}],
miscTaxRate: '<string>',
miscTax: '<string>',
miscTotalBeforeTax: '<string>',
miscLineItems: [{description: '<string>', amount: '<string>'}],
incurredCostTotalBeforeTax: '<string>',
incurredCostLineItems: [{description: '<string>', amount: '<string>'}],
proposalPdfLink: '<string>',
declineNotes: [
{
text: '<string>',
noteAddedBy: '<string>',
noteAddedAt: '2023-11-07T05:31:56Z',
id: 123,
photo: '<string>',
video: '<string>',
audio: '<string>',
otherFile: '<string>',
elements: [
{
type: '<string>',
value: '<string>',
userObject: {
email: '<string>',
nameGiven: '<string>',
nameFamily: '<string>',
contactType: '<string>',
title: '<string>',
department: '<string>',
facilityId: 123,
isSharedContact: true,
readOnlyAccess: true,
invitedByEmail: '<string>',
invitedAt: '2023-11-07T05:31:56Z',
epaCertificationType: '<string>',
epaCertificationNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z'
}
}
],
noteReadDetails: [
{
readAt: '2023-11-07T05:31:56Z',
readBy: '<string>',
readByContact: {
email: '<string>',
nameGiven: '<string>',
nameFamily: '<string>',
contactType: '<string>',
title: '<string>',
department: '<string>',
facilityId: 123,
isSharedContact: true,
readOnlyAccess: true,
invitedByEmail: '<string>',
invitedAt: '2023-11-07T05:31:56Z',
epaCertificationType: '<string>',
epaCertificationNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z'
}
}
],
noteAddedByContact: {
email: '<string>',
nameGiven: '<string>',
nameFamily: '<string>',
contactType: '<string>',
title: '<string>',
department: '<string>',
facilityId: 123,
isSharedContact: true,
readOnlyAccess: true,
invitedByEmail: '<string>',
invitedAt: '2023-11-07T05:31:56Z',
epaCertificationType: '<string>',
epaCertificationNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z'
},
noteType: '<string>',
noteAddedByType: '<string>',
caption: '<string>',
isNoteAwaitingResponse: true
}
],
requestForProposalId: 123,
isAiParsed: true,
isAiParsedEdited: true,
aiParseMismatchSignedByEmail: '<string>'
})
};
fetch('https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workOrderId' => 123,
'totalAfterTax' => '<string>',
'id' => 123,
'scope' => '<string>',
'attachments' => [
[
'fileName' => '<string>',
'fileId' => '<string>'
]
],
'taxRate' => '<string>',
'tax' => '<string>',
'totalBeforeTax' => '<string>',
'laborTaxRate' => '<string>',
'laborTax' => '<string>',
'laborTotalBeforeTax' => '<string>',
'laborLineItems' => [
[
'numberOfTech' => 123,
'seconds' => 123,
'description' => '<string>',
'roleType' => '<string>',
'laborType' => '<string>',
'hourlyRate' => '<string>',
'amount' => '<string>'
]
],
'materialTaxRate' => '<string>',
'materialTax' => '<string>',
'materialTotalBeforeTax' => '<string>',
'materialLineItems' => [
[
'unitType' => '<string>',
'quantity' => '<string>',
'description' => '<string>',
'partNumber' => '<string>',
'partId' => 123,
'equipmentNumber' => '<string>',
'equipmentId' => 123,
'unitPrice' => '<string>',
'amount' => '<string>'
]
],
'travelTaxRate' => '<string>',
'travelTax' => '<string>',
'travelTotalBeforeTax' => '<string>',
'travelLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'freightTaxRate' => '<string>',
'freightTax' => '<string>',
'freightTotalBeforeTax' => '<string>',
'freightLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'miscTaxRate' => '<string>',
'miscTax' => '<string>',
'miscTotalBeforeTax' => '<string>',
'miscLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'incurredCostTotalBeforeTax' => '<string>',
'incurredCostLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'proposalPdfLink' => '<string>',
'declineNotes' => [
[
'text' => '<string>',
'noteAddedBy' => '<string>',
'noteAddedAt' => '2023-11-07T05:31:56Z',
'id' => 123,
'photo' => '<string>',
'video' => '<string>',
'audio' => '<string>',
'otherFile' => '<string>',
'elements' => [
[
'type' => '<string>',
'value' => '<string>',
'userObject' => [
'email' => '<string>',
'nameGiven' => '<string>',
'nameFamily' => '<string>',
'contactType' => '<string>',
'title' => '<string>',
'department' => '<string>',
'facilityId' => 123,
'isSharedContact' => true,
'readOnlyAccess' => true,
'invitedByEmail' => '<string>',
'invitedAt' => '2023-11-07T05:31:56Z',
'epaCertificationType' => '<string>',
'epaCertificationNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
],
'noteReadDetails' => [
[
'readAt' => '2023-11-07T05:31:56Z',
'readBy' => '<string>',
'readByContact' => [
'email' => '<string>',
'nameGiven' => '<string>',
'nameFamily' => '<string>',
'contactType' => '<string>',
'title' => '<string>',
'department' => '<string>',
'facilityId' => 123,
'isSharedContact' => true,
'readOnlyAccess' => true,
'invitedByEmail' => '<string>',
'invitedAt' => '2023-11-07T05:31:56Z',
'epaCertificationType' => '<string>',
'epaCertificationNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
],
'noteAddedByContact' => [
'email' => '<string>',
'nameGiven' => '<string>',
'nameFamily' => '<string>',
'contactType' => '<string>',
'title' => '<string>',
'department' => '<string>',
'facilityId' => 123,
'isSharedContact' => true,
'readOnlyAccess' => true,
'invitedByEmail' => '<string>',
'invitedAt' => '2023-11-07T05:31:56Z',
'epaCertificationType' => '<string>',
'epaCertificationNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z'
],
'noteType' => '<string>',
'noteAddedByType' => '<string>',
'caption' => '<string>',
'isNoteAwaitingResponse' => true
]
],
'requestForProposalId' => 123,
'isAiParsed' => true,
'isAiParsedEdited' => true,
'aiParseMismatchSignedByEmail' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals"
payload := strings.NewReader("{\n \"workOrderId\": 123,\n \"totalAfterTax\": \"<string>\",\n \"id\": 123,\n \"scope\": \"<string>\",\n \"attachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileId\": \"<string>\"\n }\n ],\n \"taxRate\": \"<string>\",\n \"tax\": \"<string>\",\n \"totalBeforeTax\": \"<string>\",\n \"laborTaxRate\": \"<string>\",\n \"laborTax\": \"<string>\",\n \"laborTotalBeforeTax\": \"<string>\",\n \"laborLineItems\": [\n {\n \"numberOfTech\": 123,\n \"seconds\": 123,\n \"description\": \"<string>\",\n \"roleType\": \"<string>\",\n \"laborType\": \"<string>\",\n \"hourlyRate\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"materialTaxRate\": \"<string>\",\n \"materialTax\": \"<string>\",\n \"materialTotalBeforeTax\": \"<string>\",\n \"materialLineItems\": [\n {\n \"unitType\": \"<string>\",\n \"quantity\": \"<string>\",\n \"description\": \"<string>\",\n \"partNumber\": \"<string>\",\n \"partId\": 123,\n \"equipmentNumber\": \"<string>\",\n \"equipmentId\": 123,\n \"unitPrice\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"travelTaxRate\": \"<string>\",\n \"travelTax\": \"<string>\",\n \"travelTotalBeforeTax\": \"<string>\",\n \"travelLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"freightTaxRate\": \"<string>\",\n \"freightTax\": \"<string>\",\n \"freightTotalBeforeTax\": \"<string>\",\n \"freightLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"miscTaxRate\": \"<string>\",\n \"miscTax\": \"<string>\",\n \"miscTotalBeforeTax\": \"<string>\",\n \"miscLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"incurredCostTotalBeforeTax\": \"<string>\",\n \"incurredCostLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"proposalPdfLink\": \"<string>\",\n \"declineNotes\": [\n {\n \"text\": \"<string>\",\n \"noteAddedBy\": \"<string>\",\n \"noteAddedAt\": \"2023-11-07T05:31:56Z\",\n \"id\": 123,\n \"photo\": \"<string>\",\n \"video\": \"<string>\",\n \"audio\": \"<string>\",\n \"otherFile\": \"<string>\",\n \"elements\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"userObject\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteReadDetails\": [\n {\n \"readAt\": \"2023-11-07T05:31:56Z\",\n \"readBy\": \"<string>\",\n \"readByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteAddedByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"noteType\": \"<string>\",\n \"noteAddedByType\": \"<string>\",\n \"caption\": \"<string>\",\n \"isNoteAwaitingResponse\": true\n }\n ],\n \"requestForProposalId\": 123,\n \"isAiParsed\": true,\n \"isAiParsedEdited\": true,\n \"aiParseMismatchSignedByEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workOrderId\": 123,\n \"totalAfterTax\": \"<string>\",\n \"id\": 123,\n \"scope\": \"<string>\",\n \"attachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileId\": \"<string>\"\n }\n ],\n \"taxRate\": \"<string>\",\n \"tax\": \"<string>\",\n \"totalBeforeTax\": \"<string>\",\n \"laborTaxRate\": \"<string>\",\n \"laborTax\": \"<string>\",\n \"laborTotalBeforeTax\": \"<string>\",\n \"laborLineItems\": [\n {\n \"numberOfTech\": 123,\n \"seconds\": 123,\n \"description\": \"<string>\",\n \"roleType\": \"<string>\",\n \"laborType\": \"<string>\",\n \"hourlyRate\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"materialTaxRate\": \"<string>\",\n \"materialTax\": \"<string>\",\n \"materialTotalBeforeTax\": \"<string>\",\n \"materialLineItems\": [\n {\n \"unitType\": \"<string>\",\n \"quantity\": \"<string>\",\n \"description\": \"<string>\",\n \"partNumber\": \"<string>\",\n \"partId\": 123,\n \"equipmentNumber\": \"<string>\",\n \"equipmentId\": 123,\n \"unitPrice\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"travelTaxRate\": \"<string>\",\n \"travelTax\": \"<string>\",\n \"travelTotalBeforeTax\": \"<string>\",\n \"travelLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"freightTaxRate\": \"<string>\",\n \"freightTax\": \"<string>\",\n \"freightTotalBeforeTax\": \"<string>\",\n \"freightLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"miscTaxRate\": \"<string>\",\n \"miscTax\": \"<string>\",\n \"miscTotalBeforeTax\": \"<string>\",\n \"miscLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"incurredCostTotalBeforeTax\": \"<string>\",\n \"incurredCostLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"proposalPdfLink\": \"<string>\",\n \"declineNotes\": [\n {\n \"text\": \"<string>\",\n \"noteAddedBy\": \"<string>\",\n \"noteAddedAt\": \"2023-11-07T05:31:56Z\",\n \"id\": 123,\n \"photo\": \"<string>\",\n \"video\": \"<string>\",\n \"audio\": \"<string>\",\n \"otherFile\": \"<string>\",\n \"elements\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"userObject\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteReadDetails\": [\n {\n \"readAt\": \"2023-11-07T05:31:56Z\",\n \"readBy\": \"<string>\",\n \"readByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteAddedByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"noteType\": \"<string>\",\n \"noteAddedByType\": \"<string>\",\n \"caption\": \"<string>\",\n \"isNoteAwaitingResponse\": true\n }\n ],\n \"requestForProposalId\": 123,\n \"isAiParsed\": true,\n \"isAiParsedEdited\": true,\n \"aiParseMismatchSignedByEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workOrderId\": 123,\n \"totalAfterTax\": \"<string>\",\n \"id\": 123,\n \"scope\": \"<string>\",\n \"attachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileId\": \"<string>\"\n }\n ],\n \"taxRate\": \"<string>\",\n \"tax\": \"<string>\",\n \"totalBeforeTax\": \"<string>\",\n \"laborTaxRate\": \"<string>\",\n \"laborTax\": \"<string>\",\n \"laborTotalBeforeTax\": \"<string>\",\n \"laborLineItems\": [\n {\n \"numberOfTech\": 123,\n \"seconds\": 123,\n \"description\": \"<string>\",\n \"roleType\": \"<string>\",\n \"laborType\": \"<string>\",\n \"hourlyRate\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"materialTaxRate\": \"<string>\",\n \"materialTax\": \"<string>\",\n \"materialTotalBeforeTax\": \"<string>\",\n \"materialLineItems\": [\n {\n \"unitType\": \"<string>\",\n \"quantity\": \"<string>\",\n \"description\": \"<string>\",\n \"partNumber\": \"<string>\",\n \"partId\": 123,\n \"equipmentNumber\": \"<string>\",\n \"equipmentId\": 123,\n \"unitPrice\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"travelTaxRate\": \"<string>\",\n \"travelTax\": \"<string>\",\n \"travelTotalBeforeTax\": \"<string>\",\n \"travelLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"freightTaxRate\": \"<string>\",\n \"freightTax\": \"<string>\",\n \"freightTotalBeforeTax\": \"<string>\",\n \"freightLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"miscTaxRate\": \"<string>\",\n \"miscTax\": \"<string>\",\n \"miscTotalBeforeTax\": \"<string>\",\n \"miscLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"incurredCostTotalBeforeTax\": \"<string>\",\n \"incurredCostLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"proposalPdfLink\": \"<string>\",\n \"declineNotes\": [\n {\n \"text\": \"<string>\",\n \"noteAddedBy\": \"<string>\",\n \"noteAddedAt\": \"2023-11-07T05:31:56Z\",\n \"id\": 123,\n \"photo\": \"<string>\",\n \"video\": \"<string>\",\n \"audio\": \"<string>\",\n \"otherFile\": \"<string>\",\n \"elements\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"userObject\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteReadDetails\": [\n {\n \"readAt\": \"2023-11-07T05:31:56Z\",\n \"readBy\": \"<string>\",\n \"readByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteAddedByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"noteType\": \"<string>\",\n \"noteAddedByType\": \"<string>\",\n \"caption\": \"<string>\",\n \"isNoteAwaitingResponse\": true\n }\n ],\n \"requestForProposalId\": 123,\n \"isAiParsed\": true,\n \"isAiParsedEdited\": true,\n \"aiParseMismatchSignedByEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"id": 123,
"status": "<string>",
"scope": "<string>",
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"taxRate": "<string>",
"tax": "<string>",
"totalBeforeTax": "<string>",
"totalAfterTax": "<string>",
"laborTotalBeforeTax": "<string>",
"materialTotalBeforeTax": "<string>",
"travelTotalBeforeTax": "<string>",
"freightTotalBeforeTax": "<string>",
"miscTotalBeforeTax": "<string>",
"approvedAt": "2023-11-07T05:31:56Z",
"proposalPdfLink": "<string>",
"declineNotes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": true
}
],
"supplierFacilityId": 123,
"requestForProposalId": 123,
"workOrderId": 123,
"workOrderNTEBeforeApproval": 123,
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isBuyerUploaded": true,
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"submittedBy": "<string>",
"submittedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"laborLineItems": [
{
"numberOfTech": 123,
"seconds": 123,
"description": "<string>",
"roleType": "<string>",
"laborType": "<string>",
"hourlyRate": "<string>",
"amount": "<string>"
}
],
"materialLineItems": [
{
"unitType": "<string>",
"quantity": "<string>",
"description": "<string>",
"partNumber": "<string>",
"partId": 123,
"equipmentNumber": "<string>",
"equipmentId": 123,
"unitPrice": "<string>",
"amount": "<string>"
}
],
"travelLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"freightLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"miscLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
]
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Proposals
Create (submit) a proposal
Creates a proposal for a work order. Not available to internal-service-team keys (their supplier company is private to a buyer). The proposal is created directly in “pending” status under the API key’s supplier facility.
POST
/
v1
/
supplier
/
quote
/
proposals
Create (submit) a proposal
curl --request POST \
--url https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals \
--header 'Content-Type: application/json' \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"workOrderId": 123,
"totalAfterTax": "<string>",
"id": 123,
"scope": "<string>",
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"taxRate": "<string>",
"tax": "<string>",
"totalBeforeTax": "<string>",
"laborTaxRate": "<string>",
"laborTax": "<string>",
"laborTotalBeforeTax": "<string>",
"laborLineItems": [
{
"numberOfTech": 123,
"seconds": 123,
"description": "<string>",
"roleType": "<string>",
"laborType": "<string>",
"hourlyRate": "<string>",
"amount": "<string>"
}
],
"materialTaxRate": "<string>",
"materialTax": "<string>",
"materialTotalBeforeTax": "<string>",
"materialLineItems": [
{
"unitType": "<string>",
"quantity": "<string>",
"description": "<string>",
"partNumber": "<string>",
"partId": 123,
"equipmentNumber": "<string>",
"equipmentId": 123,
"unitPrice": "<string>",
"amount": "<string>"
}
],
"travelTaxRate": "<string>",
"travelTax": "<string>",
"travelTotalBeforeTax": "<string>",
"travelLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"freightTaxRate": "<string>",
"freightTax": "<string>",
"freightTotalBeforeTax": "<string>",
"freightLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"miscTaxRate": "<string>",
"miscTax": "<string>",
"miscTotalBeforeTax": "<string>",
"miscLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"incurredCostTotalBeforeTax": "<string>",
"incurredCostLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"proposalPdfLink": "<string>",
"declineNotes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": true
}
],
"requestForProposalId": 123,
"isAiParsed": true,
"isAiParsedEdited": true,
"aiParseMismatchSignedByEmail": "<string>"
}
'import requests
url = "https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals"
payload = {
"workOrderId": 123,
"totalAfterTax": "<string>",
"id": 123,
"scope": "<string>",
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"taxRate": "<string>",
"tax": "<string>",
"totalBeforeTax": "<string>",
"laborTaxRate": "<string>",
"laborTax": "<string>",
"laborTotalBeforeTax": "<string>",
"laborLineItems": [
{
"numberOfTech": 123,
"seconds": 123,
"description": "<string>",
"roleType": "<string>",
"laborType": "<string>",
"hourlyRate": "<string>",
"amount": "<string>"
}
],
"materialTaxRate": "<string>",
"materialTax": "<string>",
"materialTotalBeforeTax": "<string>",
"materialLineItems": [
{
"unitType": "<string>",
"quantity": "<string>",
"description": "<string>",
"partNumber": "<string>",
"partId": 123,
"equipmentNumber": "<string>",
"equipmentId": 123,
"unitPrice": "<string>",
"amount": "<string>"
}
],
"travelTaxRate": "<string>",
"travelTax": "<string>",
"travelTotalBeforeTax": "<string>",
"travelLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"freightTaxRate": "<string>",
"freightTax": "<string>",
"freightTotalBeforeTax": "<string>",
"freightLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"miscTaxRate": "<string>",
"miscTax": "<string>",
"miscTotalBeforeTax": "<string>",
"miscLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"incurredCostTotalBeforeTax": "<string>",
"incurredCostLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"proposalPdfLink": "<string>",
"declineNotes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": True,
"readOnlyAccess": True,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": True,
"readOnlyAccess": True,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": True,
"readOnlyAccess": True,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": True
}
],
"requestForProposalId": 123,
"isAiParsed": True,
"isAiParsedEdited": True,
"aiParseMismatchSignedByEmail": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'OW-KEY': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workOrderId: 123,
totalAfterTax: '<string>',
id: 123,
scope: '<string>',
attachments: [{fileName: '<string>', fileId: '<string>'}],
taxRate: '<string>',
tax: '<string>',
totalBeforeTax: '<string>',
laborTaxRate: '<string>',
laborTax: '<string>',
laborTotalBeforeTax: '<string>',
laborLineItems: [
{
numberOfTech: 123,
seconds: 123,
description: '<string>',
roleType: '<string>',
laborType: '<string>',
hourlyRate: '<string>',
amount: '<string>'
}
],
materialTaxRate: '<string>',
materialTax: '<string>',
materialTotalBeforeTax: '<string>',
materialLineItems: [
{
unitType: '<string>',
quantity: '<string>',
description: '<string>',
partNumber: '<string>',
partId: 123,
equipmentNumber: '<string>',
equipmentId: 123,
unitPrice: '<string>',
amount: '<string>'
}
],
travelTaxRate: '<string>',
travelTax: '<string>',
travelTotalBeforeTax: '<string>',
travelLineItems: [{description: '<string>', amount: '<string>'}],
freightTaxRate: '<string>',
freightTax: '<string>',
freightTotalBeforeTax: '<string>',
freightLineItems: [{description: '<string>', amount: '<string>'}],
miscTaxRate: '<string>',
miscTax: '<string>',
miscTotalBeforeTax: '<string>',
miscLineItems: [{description: '<string>', amount: '<string>'}],
incurredCostTotalBeforeTax: '<string>',
incurredCostLineItems: [{description: '<string>', amount: '<string>'}],
proposalPdfLink: '<string>',
declineNotes: [
{
text: '<string>',
noteAddedBy: '<string>',
noteAddedAt: '2023-11-07T05:31:56Z',
id: 123,
photo: '<string>',
video: '<string>',
audio: '<string>',
otherFile: '<string>',
elements: [
{
type: '<string>',
value: '<string>',
userObject: {
email: '<string>',
nameGiven: '<string>',
nameFamily: '<string>',
contactType: '<string>',
title: '<string>',
department: '<string>',
facilityId: 123,
isSharedContact: true,
readOnlyAccess: true,
invitedByEmail: '<string>',
invitedAt: '2023-11-07T05:31:56Z',
epaCertificationType: '<string>',
epaCertificationNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z'
}
}
],
noteReadDetails: [
{
readAt: '2023-11-07T05:31:56Z',
readBy: '<string>',
readByContact: {
email: '<string>',
nameGiven: '<string>',
nameFamily: '<string>',
contactType: '<string>',
title: '<string>',
department: '<string>',
facilityId: 123,
isSharedContact: true,
readOnlyAccess: true,
invitedByEmail: '<string>',
invitedAt: '2023-11-07T05:31:56Z',
epaCertificationType: '<string>',
epaCertificationNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z'
}
}
],
noteAddedByContact: {
email: '<string>',
nameGiven: '<string>',
nameFamily: '<string>',
contactType: '<string>',
title: '<string>',
department: '<string>',
facilityId: 123,
isSharedContact: true,
readOnlyAccess: true,
invitedByEmail: '<string>',
invitedAt: '2023-11-07T05:31:56Z',
epaCertificationType: '<string>',
epaCertificationNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z'
},
noteType: '<string>',
noteAddedByType: '<string>',
caption: '<string>',
isNoteAwaitingResponse: true
}
],
requestForProposalId: 123,
isAiParsed: true,
isAiParsedEdited: true,
aiParseMismatchSignedByEmail: '<string>'
})
};
fetch('https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workOrderId' => 123,
'totalAfterTax' => '<string>',
'id' => 123,
'scope' => '<string>',
'attachments' => [
[
'fileName' => '<string>',
'fileId' => '<string>'
]
],
'taxRate' => '<string>',
'tax' => '<string>',
'totalBeforeTax' => '<string>',
'laborTaxRate' => '<string>',
'laborTax' => '<string>',
'laborTotalBeforeTax' => '<string>',
'laborLineItems' => [
[
'numberOfTech' => 123,
'seconds' => 123,
'description' => '<string>',
'roleType' => '<string>',
'laborType' => '<string>',
'hourlyRate' => '<string>',
'amount' => '<string>'
]
],
'materialTaxRate' => '<string>',
'materialTax' => '<string>',
'materialTotalBeforeTax' => '<string>',
'materialLineItems' => [
[
'unitType' => '<string>',
'quantity' => '<string>',
'description' => '<string>',
'partNumber' => '<string>',
'partId' => 123,
'equipmentNumber' => '<string>',
'equipmentId' => 123,
'unitPrice' => '<string>',
'amount' => '<string>'
]
],
'travelTaxRate' => '<string>',
'travelTax' => '<string>',
'travelTotalBeforeTax' => '<string>',
'travelLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'freightTaxRate' => '<string>',
'freightTax' => '<string>',
'freightTotalBeforeTax' => '<string>',
'freightLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'miscTaxRate' => '<string>',
'miscTax' => '<string>',
'miscTotalBeforeTax' => '<string>',
'miscLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'incurredCostTotalBeforeTax' => '<string>',
'incurredCostLineItems' => [
[
'description' => '<string>',
'amount' => '<string>'
]
],
'proposalPdfLink' => '<string>',
'declineNotes' => [
[
'text' => '<string>',
'noteAddedBy' => '<string>',
'noteAddedAt' => '2023-11-07T05:31:56Z',
'id' => 123,
'photo' => '<string>',
'video' => '<string>',
'audio' => '<string>',
'otherFile' => '<string>',
'elements' => [
[
'type' => '<string>',
'value' => '<string>',
'userObject' => [
'email' => '<string>',
'nameGiven' => '<string>',
'nameFamily' => '<string>',
'contactType' => '<string>',
'title' => '<string>',
'department' => '<string>',
'facilityId' => 123,
'isSharedContact' => true,
'readOnlyAccess' => true,
'invitedByEmail' => '<string>',
'invitedAt' => '2023-11-07T05:31:56Z',
'epaCertificationType' => '<string>',
'epaCertificationNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
],
'noteReadDetails' => [
[
'readAt' => '2023-11-07T05:31:56Z',
'readBy' => '<string>',
'readByContact' => [
'email' => '<string>',
'nameGiven' => '<string>',
'nameFamily' => '<string>',
'contactType' => '<string>',
'title' => '<string>',
'department' => '<string>',
'facilityId' => 123,
'isSharedContact' => true,
'readOnlyAccess' => true,
'invitedByEmail' => '<string>',
'invitedAt' => '2023-11-07T05:31:56Z',
'epaCertificationType' => '<string>',
'epaCertificationNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
],
'noteAddedByContact' => [
'email' => '<string>',
'nameGiven' => '<string>',
'nameFamily' => '<string>',
'contactType' => '<string>',
'title' => '<string>',
'department' => '<string>',
'facilityId' => 123,
'isSharedContact' => true,
'readOnlyAccess' => true,
'invitedByEmail' => '<string>',
'invitedAt' => '2023-11-07T05:31:56Z',
'epaCertificationType' => '<string>',
'epaCertificationNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z'
],
'noteType' => '<string>',
'noteAddedByType' => '<string>',
'caption' => '<string>',
'isNoteAwaitingResponse' => true
]
],
'requestForProposalId' => 123,
'isAiParsed' => true,
'isAiParsedEdited' => true,
'aiParseMismatchSignedByEmail' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals"
payload := strings.NewReader("{\n \"workOrderId\": 123,\n \"totalAfterTax\": \"<string>\",\n \"id\": 123,\n \"scope\": \"<string>\",\n \"attachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileId\": \"<string>\"\n }\n ],\n \"taxRate\": \"<string>\",\n \"tax\": \"<string>\",\n \"totalBeforeTax\": \"<string>\",\n \"laborTaxRate\": \"<string>\",\n \"laborTax\": \"<string>\",\n \"laborTotalBeforeTax\": \"<string>\",\n \"laborLineItems\": [\n {\n \"numberOfTech\": 123,\n \"seconds\": 123,\n \"description\": \"<string>\",\n \"roleType\": \"<string>\",\n \"laborType\": \"<string>\",\n \"hourlyRate\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"materialTaxRate\": \"<string>\",\n \"materialTax\": \"<string>\",\n \"materialTotalBeforeTax\": \"<string>\",\n \"materialLineItems\": [\n {\n \"unitType\": \"<string>\",\n \"quantity\": \"<string>\",\n \"description\": \"<string>\",\n \"partNumber\": \"<string>\",\n \"partId\": 123,\n \"equipmentNumber\": \"<string>\",\n \"equipmentId\": 123,\n \"unitPrice\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"travelTaxRate\": \"<string>\",\n \"travelTax\": \"<string>\",\n \"travelTotalBeforeTax\": \"<string>\",\n \"travelLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"freightTaxRate\": \"<string>\",\n \"freightTax\": \"<string>\",\n \"freightTotalBeforeTax\": \"<string>\",\n \"freightLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"miscTaxRate\": \"<string>\",\n \"miscTax\": \"<string>\",\n \"miscTotalBeforeTax\": \"<string>\",\n \"miscLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"incurredCostTotalBeforeTax\": \"<string>\",\n \"incurredCostLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"proposalPdfLink\": \"<string>\",\n \"declineNotes\": [\n {\n \"text\": \"<string>\",\n \"noteAddedBy\": \"<string>\",\n \"noteAddedAt\": \"2023-11-07T05:31:56Z\",\n \"id\": 123,\n \"photo\": \"<string>\",\n \"video\": \"<string>\",\n \"audio\": \"<string>\",\n \"otherFile\": \"<string>\",\n \"elements\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"userObject\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteReadDetails\": [\n {\n \"readAt\": \"2023-11-07T05:31:56Z\",\n \"readBy\": \"<string>\",\n \"readByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteAddedByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"noteType\": \"<string>\",\n \"noteAddedByType\": \"<string>\",\n \"caption\": \"<string>\",\n \"isNoteAwaitingResponse\": true\n }\n ],\n \"requestForProposalId\": 123,\n \"isAiParsed\": true,\n \"isAiParsedEdited\": true,\n \"aiParseMismatchSignedByEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workOrderId\": 123,\n \"totalAfterTax\": \"<string>\",\n \"id\": 123,\n \"scope\": \"<string>\",\n \"attachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileId\": \"<string>\"\n }\n ],\n \"taxRate\": \"<string>\",\n \"tax\": \"<string>\",\n \"totalBeforeTax\": \"<string>\",\n \"laborTaxRate\": \"<string>\",\n \"laborTax\": \"<string>\",\n \"laborTotalBeforeTax\": \"<string>\",\n \"laborLineItems\": [\n {\n \"numberOfTech\": 123,\n \"seconds\": 123,\n \"description\": \"<string>\",\n \"roleType\": \"<string>\",\n \"laborType\": \"<string>\",\n \"hourlyRate\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"materialTaxRate\": \"<string>\",\n \"materialTax\": \"<string>\",\n \"materialTotalBeforeTax\": \"<string>\",\n \"materialLineItems\": [\n {\n \"unitType\": \"<string>\",\n \"quantity\": \"<string>\",\n \"description\": \"<string>\",\n \"partNumber\": \"<string>\",\n \"partId\": 123,\n \"equipmentNumber\": \"<string>\",\n \"equipmentId\": 123,\n \"unitPrice\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"travelTaxRate\": \"<string>\",\n \"travelTax\": \"<string>\",\n \"travelTotalBeforeTax\": \"<string>\",\n \"travelLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"freightTaxRate\": \"<string>\",\n \"freightTax\": \"<string>\",\n \"freightTotalBeforeTax\": \"<string>\",\n \"freightLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"miscTaxRate\": \"<string>\",\n \"miscTax\": \"<string>\",\n \"miscTotalBeforeTax\": \"<string>\",\n \"miscLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"incurredCostTotalBeforeTax\": \"<string>\",\n \"incurredCostLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"proposalPdfLink\": \"<string>\",\n \"declineNotes\": [\n {\n \"text\": \"<string>\",\n \"noteAddedBy\": \"<string>\",\n \"noteAddedAt\": \"2023-11-07T05:31:56Z\",\n \"id\": 123,\n \"photo\": \"<string>\",\n \"video\": \"<string>\",\n \"audio\": \"<string>\",\n \"otherFile\": \"<string>\",\n \"elements\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"userObject\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteReadDetails\": [\n {\n \"readAt\": \"2023-11-07T05:31:56Z\",\n \"readBy\": \"<string>\",\n \"readByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteAddedByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"noteType\": \"<string>\",\n \"noteAddedByType\": \"<string>\",\n \"caption\": \"<string>\",\n \"isNoteAwaitingResponse\": true\n }\n ],\n \"requestForProposalId\": 123,\n \"isAiParsed\": true,\n \"isAiParsedEdited\": true,\n \"aiParseMismatchSignedByEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/supplier/quote/proposals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workOrderId\": 123,\n \"totalAfterTax\": \"<string>\",\n \"id\": 123,\n \"scope\": \"<string>\",\n \"attachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileId\": \"<string>\"\n }\n ],\n \"taxRate\": \"<string>\",\n \"tax\": \"<string>\",\n \"totalBeforeTax\": \"<string>\",\n \"laborTaxRate\": \"<string>\",\n \"laborTax\": \"<string>\",\n \"laborTotalBeforeTax\": \"<string>\",\n \"laborLineItems\": [\n {\n \"numberOfTech\": 123,\n \"seconds\": 123,\n \"description\": \"<string>\",\n \"roleType\": \"<string>\",\n \"laborType\": \"<string>\",\n \"hourlyRate\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"materialTaxRate\": \"<string>\",\n \"materialTax\": \"<string>\",\n \"materialTotalBeforeTax\": \"<string>\",\n \"materialLineItems\": [\n {\n \"unitType\": \"<string>\",\n \"quantity\": \"<string>\",\n \"description\": \"<string>\",\n \"partNumber\": \"<string>\",\n \"partId\": 123,\n \"equipmentNumber\": \"<string>\",\n \"equipmentId\": 123,\n \"unitPrice\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"travelTaxRate\": \"<string>\",\n \"travelTax\": \"<string>\",\n \"travelTotalBeforeTax\": \"<string>\",\n \"travelLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"freightTaxRate\": \"<string>\",\n \"freightTax\": \"<string>\",\n \"freightTotalBeforeTax\": \"<string>\",\n \"freightLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"miscTaxRate\": \"<string>\",\n \"miscTax\": \"<string>\",\n \"miscTotalBeforeTax\": \"<string>\",\n \"miscLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"incurredCostTotalBeforeTax\": \"<string>\",\n \"incurredCostLineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ],\n \"proposalPdfLink\": \"<string>\",\n \"declineNotes\": [\n {\n \"text\": \"<string>\",\n \"noteAddedBy\": \"<string>\",\n \"noteAddedAt\": \"2023-11-07T05:31:56Z\",\n \"id\": 123,\n \"photo\": \"<string>\",\n \"video\": \"<string>\",\n \"audio\": \"<string>\",\n \"otherFile\": \"<string>\",\n \"elements\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"userObject\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteReadDetails\": [\n {\n \"readAt\": \"2023-11-07T05:31:56Z\",\n \"readBy\": \"<string>\",\n \"readByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n }\n ],\n \"noteAddedByContact\": {\n \"email\": \"<string>\",\n \"nameGiven\": \"<string>\",\n \"nameFamily\": \"<string>\",\n \"contactType\": \"<string>\",\n \"title\": \"<string>\",\n \"department\": \"<string>\",\n \"facilityId\": 123,\n \"isSharedContact\": true,\n \"readOnlyAccess\": true,\n \"invitedByEmail\": \"<string>\",\n \"invitedAt\": \"2023-11-07T05:31:56Z\",\n \"epaCertificationType\": \"<string>\",\n \"epaCertificationNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"noteType\": \"<string>\",\n \"noteAddedByType\": \"<string>\",\n \"caption\": \"<string>\",\n \"isNoteAwaitingResponse\": true\n }\n ],\n \"requestForProposalId\": 123,\n \"isAiParsed\": true,\n \"isAiParsedEdited\": true,\n \"aiParseMismatchSignedByEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"id": 123,
"status": "<string>",
"scope": "<string>",
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"taxRate": "<string>",
"tax": "<string>",
"totalBeforeTax": "<string>",
"totalAfterTax": "<string>",
"laborTotalBeforeTax": "<string>",
"materialTotalBeforeTax": "<string>",
"travelTotalBeforeTax": "<string>",
"freightTotalBeforeTax": "<string>",
"miscTotalBeforeTax": "<string>",
"approvedAt": "2023-11-07T05:31:56Z",
"proposalPdfLink": "<string>",
"declineNotes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"id": 123,
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "<string>",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"caption": "<string>",
"isNoteAwaitingResponse": true
}
],
"supplierFacilityId": 123,
"requestForProposalId": 123,
"workOrderId": 123,
"workOrderNTEBeforeApproval": 123,
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isBuyerUploaded": true,
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"submittedBy": "<string>",
"submittedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"laborLineItems": [
{
"numberOfTech": 123,
"seconds": 123,
"description": "<string>",
"roleType": "<string>",
"laborType": "<string>",
"hourlyRate": "<string>",
"amount": "<string>"
}
],
"materialLineItems": [
{
"unitType": "<string>",
"quantity": "<string>",
"description": "<string>",
"partNumber": "<string>",
"partId": 123,
"equipmentNumber": "<string>",
"equipmentId": 123,
"unitPrice": "<string>",
"amount": "<string>"
}
],
"travelLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"freightLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
],
"miscLineItems": [
{
"description": "<string>",
"amount": "<string>"
}
]
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Authorizations
OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.
Body
application/json
Proposal create payload (verified against the shared proposal constructor). status is always forced to "pending" and supplierFacilityId to the API key's facility; caller values for them are ignored. Monetary values are strings and are validated as parseable numbers - laborLineItems require numeric hourlyRate and amount, materialLineItems numeric quantity, amount and unitPrice. Unknown fields are ignored.
REQUIRED. Work order the proposal is for; must exist. locationId, buyerFacilityId and buyerCompanyId are derived from it.
REQUIRED. Must parse as a number.
Existing proposal id (update semantics)
Show child attributes
Show child attributes
Defaults to "0"; must parse as a number
Defaults to "0"; must parse as a number
Defaults to "0"; must parse as a number
Must parse as a number if present
Must parse as a number if present
Defaults to "0"; must parse as a number
Show child attributes
Show child attributes
Defaults to "0"; must parse as a number
Show child attributes
Show child attributes
Defaults to "0"; must parse as a number
Show child attributes
Show child attributes
Defaults to "0"; must parse as a number
Show child attributes
Show child attributes
Each amount must parse as a number
Show child attributes
Show child attributes
Each amount must parse as a number
Show child attributes
Show child attributes
Must be a valid URL
Show child attributes
Show child attributes
Defaults to the work order's RFP when omitted
Client-asserted AI-parse provenance; default false
Default false
Response
Successful response
Entity type label, e.g. "Proposal". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.
Proposal / quote (abridged - approval-hierarchy, capex/rm category and hydrated relation fields omitted).
Show child attributes
Show child attributes
"ok" on success
Available options:
ok