Skip to main content
GET
/
zapier
/
trigger
/
proposal
Zapier Trigger for Proposal Status Change
curl --request GET \
  --url http://127.0.0.1:5000/zapier/trigger/proposal \
  --header 'Accept: <accept>'
{
  "financialSummary": {
    "partsSubtotal": 123,
    "partsTotal": 123,
    "laborTotal": 123,
    "feeTotal": 123,
    "proposalSubtotal": 123,
    "salesTax": {
      "total": 123,
      "calculation": {
        "applyTo": [],
        "hasMultipleTaxSupport": true,
        "isTaxJarAvailable": true,
        "partsTax": 123,
        "partsTaxName": "<string>",
        "laborTax": 123,
        "laborTaxName": "<string>",
        "partsTax2": 123,
        "partsTax2Name": "<string>",
        "laborTax2": 123,
        "laborTax2Name": "<string>",
        "feeTax": 123,
        "feeTaxName": "<string>",
        "feeTax2": 123,
        "feeTax2Name": "<string>",
        "taxLocation": {
          "id": 123,
          "street": "<string>",
          "suite": "<string>",
          "city": "<string>",
          "postalCode": "<string>",
          "state": "<string>",
          "stateAbbrev": "<string>",
          "country": "<string>",
          "phone": "<string>"
        },
        "partsTotalTax": 123,
        "laborTotalTax": 123,
        "feeTotalTax": 123
      }
    },
    "partsDiscountPercentage": 123,
    "partsDiscount": 123,
    "partsDiscountTaxable": 123,
    "partsDiscountTaxExempt": 123,
    "proposalTotal": 123,
    "currency": {
      "code": "<string>",
      "symbol": "<string>"
    }
  },
  "id": 123,
  "number": 123,
  "status": "<string>",
  "total": 123,
  "customer": {
    "id": 123,
    "location": {
      "id": 123,
      "street": "<string>",
      "suite": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "state": "<string>",
      "stateAbbrev": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "firstName": "<string>",
    "lastName": "<string>",
    "companyName": "<string>",
    "contactEmail": "<string>",
    "contactEmailCC": "<string>",
    "contactPhone": "<string>"
  },
  "proposalPdf": "<string>",
  "proposalCsv": "<string>",
  "installerPdf": "<string>",
  "salesPerson": "<string>",
  "salesPersonEmail": "<string>",
  "areas": [
    {
      "id": 123,
      "name": "<string>",
      "options": [
        {
          "id": 123,
          "lastModifiedDate": "2023-11-07T05:31:56Z",
          "total": 123,
          "totalRecurringService": 123,
          "clientDescription": "<string>",
          "installerDescription": "<string>",
          "items": [
            {
              "id": 123,
              "referencedItemId": 123,
              "createdDate": "2023-11-07T05:31:56Z",
              "quantity": 123,
              "total": {
                "amount": 123,
                "currency": {
                  "code": "<string>",
                  "symbol": "<string>"
                },
                "isCombinedPrice": true
              },
              "parentId": 123,
              "lastModifiedDate": "2023-11-07T05:31:56Z",
              "brand": "<string>",
              "model": "<string>",
              "description": "<string>",
              "name": "<string>",
              "shortDescription": "<string>",
              "clientNote": "<string>",
              "imageUrl": "<string>",
              "msrp": 123,
              "sellPrice": 123,
              "cost": 123,
              "costUpdateDate": "2023-11-07T05:31:56Z",
              "supplier": "<string>",
              "isTaxExempt": true,
              "isRecurringService": true,
              "linkedOrders": [
                {
                  "orderId": 123,
                  "orderNumber": 123,
                  "orderNumberSuffix": "<string>",
                  "orderName": "<string>",
                  "supplier": "<string>",
                  "supplierRef": "<string>"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "profit": {
    "total": 123,
    "percentage": 123,
    "partTotal": 123,
    "partPercentage": 123,
    "laborTotal": 123,
    "laborPercentage": 123,
    "isProfitIncludeCos": true
  },
  "recurringServices": {
    "items": [
      {
        "name": "<string>",
        "sellPrice": 123,
        "quantity": 123,
        "totalSell": 123
      }
    ],
    "totalRecurringService": 123
  },
  "changeOrders": [
    {
      "id": 123,
      "number": 123,
      "name": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "lastModifiedDate": "2023-11-07T05:31:56Z",
      "total": {
        "changeOrderTotal": 123,
        "currency": {
          "code": "<string>",
          "symbol": "<string>"
        }
      },
      "customer": {
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "companyName": "<string>",
        "contactEmail": "<string>",
        "contactEmailCC": "<string>",
        "contactPhone": "<string>"
      },
      "lastModifiedByUserDate": "2023-11-07T05:31:56Z"
    }
  ],
  "name": "<string>"
}
This endpoint is used by the Portal.io Zapier integration. It fires when a proposal’s status changes in your Portal.io account — for example, when a proposal moves from Draft to Submitted, or from Submitted to Accepted. Each Zapier subscription can filter by specific statuses so that your Zap only triggers on transitions you care about.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Response

Proposal List.

ZapierProposalItem

financialSummary
PublicFinancialSummaryModel · object
required

Financial totals, discounts, tax, and currency values for the proposal

id
integer<int32>
required
number
integer<int32>
status
string
total
number<double>
customer
PublicCustomerModel · object

Customer contact

proposalPdf
string
proposalCsv
string
installerPdf
string
salesPerson
string
salesPersonEmail
string
areas
PublicAreaModel · object[]
profit
PublicProfitModel · object

Profit summary for the proposal

recurringServices
PublicRecurringServicesModel · object

Recurring service summary associated with the proposal.

changeOrders
PublicChangeOrderModel · object[]
name
string