Quotes

Get one of your quotes

Changed on

Get a quote by ID including its phases

get/quotes/{id}

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/quotes/{id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

idstring required

Quote ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

OK

idstring required

Unique ID

createdBystring required

The Sequence user who created this quote

customerIdstring

ID of Customer to which this quote pertains

quoteNumberstring required

An alpha-numeric value that identifies the quote

titlestring

The quote title

currency'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR'
status'DRAFT' | 'PUBLISHED' | 'PREPARING_SIGNATURE_REQUEST' | 'READY_TO_SIGN' | 'ACCEPTED' | 'EXECUTED' required
dealType'NEW_BUSINESS' | 'RENEWAL'
preliminaryBillingStartDatestring

Preliminary start date of contract

expiresAtstring

Date when quote expires

publishedAtstring

Timestamp when quote was published. Formatted as an ISO 8601 timestamp.

readyToSignAtstring

Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp.

acceptedAtstring

Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.

executedAtstring

Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.

createdAtstring required

Creation timestamp. Formatted as an ISO 8601 timestamp.

updatedAtstring required

Timestamp when quote was last updated. Formatted as an ISO 8601 timestamp.

salesforceOpportunityIdstring

Salesforce ID of the opportunity that created this quote

expiryDaysinteger

Number of days after publishing in which quote will expire

archivedAtstring

Date and time the quote was archived

approvalWorkflowIdstring

The ID of the active approval workflow for this quote, if one is in progress

contactIdsstring[] required

IDs of contacts who will receive this quote (and sign this quote if using e-signatures)

isSignaturesEnabledboolean required

Enable e-signatures to allow customers to sign this quote through Dropbox Sign.

customerLegalNamestring

Customer legal name

pdfStatus'NOT_YET_REQUESTED' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'GENERATED' required
isExpiredboolean required

True if the quote expiry date has passed

defaultDueDateDaysinteger

Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.

signatureMode'EMBEDDED' | 'NON_EMBEDDED'
preparingSignatureRequestAtstring

Timestamp when quote ready-to-sign operation was triggered.

Example response

{
  "id": "678ca125-8bc3-478f-9a96-6ba73605cf1e",
  "createdBy": "4ffd439e-32e5-4046-bb40-3cb81f40e5da",
  "customerId": "377bf97b-ca1d-4538-be06-4022afa6bde3",
  "quoteNumber": "Q00001",
  "title": "My quote",
  "currency": "GBP",
  "status": "ACCEPTED",
  "dealType": "NEW_BUSINESS",
  "preliminaryBillingStartDate": "2022-10-01",
  "expiresAt": "2022-10-01",
  "publishedAt": "2022-06-28T16:47:00Z",
  "readyToSignAt": "2022-06-28T16:47:00Z",
  "acceptedAt": "2022-06-28T16:47:00Z",
  "executedAt": "2022-06-28T16:47:00Z",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "createdFrom": {
    "entityType": "QUOTE",
    "entityId": "dc0e2104-7df5-4fc1-8f65-1823f427d111"
  },
  "salesforceOpportunityId": "006Hr00001MfnEIIAZ",
  "expiryDays": 30,
  "merchantBranding": {
    "logoUrl": "logo",
    "legalCompanyName": "Acme Corp",
    "primaryColour": "colour",
    "url": "www.example.com",
    "address": {
      "line1": "1 Market Street",
      "line2": "Suite 100",
      "town": "San Francisco",
      "state": "CA",
      "postcode": "94105",
      "country": "US"
    },
    "email": "accounting@example.com",
    "showUsageInCustomerPortal": true,
    "supportEmail": "support@example.com",
    "supportUrl": "https://www.example.com/support"
  },
  "phases": [
    {
      "id": "abe4bf01-9b75-495d-f5fd-ca82b001f3a8",
      "name": "Onboarding",
      "createdAt": "2022-06-28T16:47:00Z",
      "duration": {
        "days": 0,
        "weeks": 0,
        "months": 6,
        "years": 1
      },
      "prices": [
        {
          "id": "5100e884-e007-4183-8355-4771865cb4d7",
          "productId": "e007e884-5100-4183-8355-4771865cb4dd",
          "name": "Sample product",
          "structure": {
            "price": "150.00",
            "pricingType": "ONE_TIME"
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "integrationIds": [
            {
              "service": "Xero",
              "id": "123",
              "isPending": false
            }
          ],
          "customMetricParameters": [
            {
              "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
        },
        {
          "id": "5100e884-e007-4183-8355-4771865cb4d7",
          "productId": "e007e884-5100-4183-8355-4771865cb4dd",
          "name": "Sample product",
          "structure": {
            "price": "20.00",
            "pricingType": "FIXED"
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "integrationIds": [
            {
              "service": "Xero",
              "id": "123",
              "isPending": false
            }
          ],
          "customMetricParameters": [
            {
              "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
        },
        {
          "id": "5100e884-e007-4183-8355-4771865cb4d7",
          "productId": "e007e884-5100-4183-8355-4771865cb4dd",
          "name": "Sample product",
          "structure": {
            "pricePerUnit": "0.25",
            "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
            "isPricePercentage": false,
            "pricingType": "LINEAR"
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "integrationIds": [
            {
              "service": "Xero",
              "id": "123",
              "isPending": false
            }
          ],
          "customMetricParameters": [
            {
              "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
        },
        {
          "id": "5100e884-e007-4183-8355-4771865cb4d7",
          "productId": "e007e884-5100-4183-8355-4771865cb4dd",
          "name": "Sample product",
          "structure": {
            "seatMetricId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
            "pricePerSeat": "0.25",
            "prorationStrategy": "USE_MAXIMUM",
            "contractedMinimumSeats": 10,
            "overagesBillingFrequency": "YEARLY",
            "tiers": [
              {
                "upperBound": "100",
                "price": "1.00",
                "fee": "50.00"
              },
              {
                "price": "0.75",
                "fee": "25.00"
              }
            ],
            "prorateFlatFees": false,
            "pricingType": "SEAT_BASED"
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "integrationIds": [
            {
              "service": "Xero",
              "id": "123",
              "isPending": false
            }
          ],
          "customMetricParameters": [
            {
              "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
        },
        {
          "id": "5100e884-e007-4183-8355-4771865cb4d7",
          "productId": "e007e884-5100-4183-8355-4771865cb4dd",
          "name": "Sample product",
          "structure": {
            "tiers": [
              {
                "upperBound": "200",
                "price": "1.00",
                "fee": "50.00",
                "isPricePercentage": false
              },
              {
                "upperBound": "400",
                "price": "0.75",
                "fee": "25.00",
                "isPricePercentage": false
              },
              {
                "price": "0.50",
                "fee": "0.00",
                "isPricePercentage": false
              }
            ],
            "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
            "usageCalculationMode": "BILLING_PERIOD",
            "pricingType": "GRADUATED"
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "integrationIds": [
            {
              "service": "Xero",
              "id": "123",
              "isPending": false
            }
          ],
          "customMetricParameters": [
            {
              "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
          "usageCalculationPeriod": {
            "frequency": "MONTHLY",
            "interval": 1
          }
        },
        {
          "id": "5100e884-e007-4183-8355-4771865cb4d7",
          "productId": "e007e884-5100-4183-8355-4771865cb4dd",
          "name": "Sample product",
          "structure": {
            "tiers": [
              {
                "upperBound": "100",
                "price": "1.00",
                "fee": "50.00",
                "isPricePercentage": true,
                "maxPrice": "10",
                "minPrice": "5"
              },
              {
                "price": "0.75",
                "fee": "25.00",
                "isPricePercentage": true,
                "maxPrice": "10",
                "minPrice": "5"
              }
            ],
            "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
            "pricingType": "VOLUME"
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "integrationIds": [
            {
              "service": "Xero",
              "id": "123",
              "isPending": false
            }
          ],
          "customMetricParameters": [
            {
              "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
        },
        {
          "id": "5100e884-e007-4183-8355-4771865cb4d7",
          "productId": "e007e884-5100-4183-8355-4771865cb4dd",
          "name": "Sample product",
          "structure": {
            "packageSize": "50",
            "pricePerPackage": "2.00",
            "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
            "pricingType": "PACKAGE"
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "integrationIds": [
            {
              "service": "Xero",
              "id": "123",
              "isPending": false
            }
          ],
          "customMetricParameters": [
            {
              "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
        }
      ],
      "discounts": [
        {
          "id": "018f920a-40d1-7e62-91ca-f3a4b4ac5d9d",
          "restrictToPrices": [
            "5100e884-e007-4183-8355-4771865cb4d7"
          ],
          "amount": "50",
          "discountCalculationType": "PERCENTAGE",
          "message": "message",
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z",
          "seatDiscountType": "ALL_SEATS"
        }
      ],
      "minimums": [
        {
          "id": "018f9164-c2d9-7eb2-bb98-11ecb5454055",
          "amount": "50",
          "restrictToPrices": [
            "5100e884-e007-4183-8355-4771865cb4d7"
          ],
          "createdAt": "2021-08-25T12:00:00Z",
          "updatedAt": "2021-08-25T12:00:00Z"
        }
      ]
    }
  ],
  "archivedAt": "2022-06-28T16:47:00Z",
  "approvalWorkflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "contactIds": [
    "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"
  ],
  "contacts": [
    {
      "contactId": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "signedAt": "2022-06-28T16:47:00Z"
    }
  ],
  "counterSigners": [
    {
      "id": "0190da0c-980d-7fa2-9b65-4c79784a95b1",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "signedAt": "2022-06-28T16:47:00Z"
    }
  ],
  "isSignaturesEnabled": false,
  "integrationIds": [
    {
      "service": "Salesforce",
      "id": "a00Hr00001BiFbjIAF",
      "isPending": false
    }
  ],
  "customerLegalName": "Acme Corp",
  "customerAddress": {
    "line1": "1 Fake Street",
    "line2": "Fakesville",
    "town": "Faketown",
    "state": "CA",
    "postcode": "F4KE",
    "country": "US"
  },
  "pdfStatus": "NOT_YET_REQUESTED",
  "attachmentAssets": [
    {
      "id": "e007e884-5100-4183-8355-4771865cb4dd",
      "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "createdByType": "SEQUENCE_USER",
      "type": "IMAGE",
      "format": "PNG",
      "fileName": "my-image.png",
      "fileSizeBytes": 12345,
      "url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
      "createdAt": "2022-06-28T16:47:00Z"
    }
  ],
  "isExpired": false,
  "defaultDueDateDays": 30,
  "signatureMode": "EMBEDDED",
  "preparingSignatureRequestAt": "2022-06-28T16:47:00Z",
  "activeErrors": [
    {
      "id": "0190b1f2-1234-7000-8000-000000000001",
      "errorCode": "DROPBOX_SIGNATURE_REQUEST_REJECTED",
      "recoveryAction": "CONTACT_SUPPORT",
      "createdAt": "2022-06-28T16:47:00Z",
      "errorContext": {}
    }
  ]
}

Changes