SALESQUOTE

Gets sales quote details by ID.

GET/api/v2/sales-quote/{salesQuoteId}

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

salesQuoteIdpathinteger · int32required

Responses

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

salesQuoteIdinteger · int32
statusIDinteger · int32
actionstring
taxableStateLabelstring
taxableCountyLabelstring
taxableCityLabelstring
taxLevelstring
enableGroupingboolean
groupingLevelstring

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/sales-quote/SALES_QUOTE_ID' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "salesQuoteId": 1024,
    "statusID": 1024,
    "action": "string",
    "details": {
      "userID": 1024,
      "companyID": 1024,
      "contactID": 1024,
      "identifier": "string",
      "statusID": 1024,
      "status": "string",
      "calculationType": "string",
      "startDate": "2026-01-15T14:30:00Z",
      "expirationDate": "2026-01-15",
      "inboundBranchID": 1024,
      "freightOrigin": "string",
      "inboundFreight": 1.5,
      "deliveryBranchID": 1024,
      "deliveryFreight": 1.5,
      "customerFreight": 1.5,
      "attachmentFreight": 1.5,
      "tradeInFreight": 1.5,
      "fob": "string",
      "shippingAddressID": 1024,
      "totalCost": 42,
      "salePrice": 125000.5,
      "salePriceAdjustment": 125000.5,
      "tradeOverallowance": 1.5,
      "tradeValue": 125000.5,
      "netTradeAllowance": 1.5,
      "actualSalePrice": 125000.5,
      "salePriceBeforeDiscount": 42,
      "totalSalesTax": 42,
      "downPayment": 125000.5,
      "financingField1": 1.5,
      "financingField2": 1.5,
      "financingField3": 1.5,
      "financingField4": 1.5,
      "financingField5": 1.5,
      "amountToFinance": 125000.5,
      "finalProfit": 1.5,
      "finalDiscount": 42,
      "finalProfitPercent": 1.5,
      "finalDiscountPercent": 42,
      "additionalCharges": 1.5,
      "taxableCity": "string",
      "taxableState": "string",
      "taxableCounty": "string",
      "complete": true,
      "valid": true,
      "approved": true,
      "archived": false,
      "dealSheetFile": "string",
      "buyDownAvailableRate": 125000.5,
      "buyDownDesiredRate": 125000.5,
      "buyDownMonths": 1,
      "buyDownCost": 125000.5,
      "decisionComments": "string",
      "deleted": false,
      "poNumber": "string",
      "taxExempt": false,
      "dealTrackerRequestStatus": "string",
      "willCall": true,
      "willCallBranchID": 1024,
      "branchID": 1024,
      "minimumProfitPercent": 1.5,
      "targetProfitPercent": 1.5,
      "maxDiscountPercent": 42,
      "requireApprovalOnSubmit": true,
      "buyDownProgramNo": "string",
      "taxLocked": true,
      "machineExchangeFactor": 1.5,
      "discountExchangeFactor": 42,
      "reasonIds": [
        1024
      ],
      "equipValid": true,
      "showApprovalLink": true,
      "approvalId": 1024,
      "canEdit": true,
      "showSubmitDecision": true,
      "showUpdateOrUndoDecision": true
    },
    "statuses": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "transactionTypes": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "saleTypes": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "equipmentTypes": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "categories": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "taxableStates": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "taxableCounties": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "taxableCities": [
      {
        "value": "string",
        "display": "string",
        "group": "string",
        "scope": "string",
        "dateRange": true
      }
    ],
    "reasons": [
      {
        "reasonId": 1024,
        "display": "string"
      }
    ],
    "taxableStateLabel": "string",
    "taxableCountyLabel": "string",
    "taxableCityLabel": "string",
    "taxLevel": "string",
    "equipment": [
      {
        "salesQuoteId": 1024,
        "equipmentId": 1024,
        "description": "string",
        "serialNo": "CAT0320XABC12345",
        "stockNo": "STK-1001",
        "salePrice": 125000.5,
        "actualSalePrice": 125000.5,
        "finalProfitPercent": 1.5,
        "finalProfit": 1.5,
        "finalDiscountPercent": 42,
        "finalDiscount": 42,
        "minimumProfitPercent": 1.5,
        "maxDiscountPercent": 42,
        "modelId": 1024,
        "model": "320",
        "make": "Caterpillar",
        "inventoryId": 1024,
        "configurationId": 1024,
        "calculationType": "string",
        "complete": true,
        "valid": true,
        "decisionDate": "2026-01-15T14:30:00Z",
        "deliveryDate": "2026-01-15T14:30:00Z",
        "transactionTypeId": 1024,
        "equipmentTypeId": 1024,
        "saleTypeId": 1024,
        "tradeOverallowance": 1.5,
        "transactionType": "string",
        "saleType": "string",
        "equipmentType": "string",
        "decisionComments": "string",
        "financeComments": "string",
        "thresholdExceeded": true,
        "closedStatusId": 1024,
        "dealId": 1024,
        "dealTrackerRequestStatus": "string",
        "dealIdentifier": "string",
        "newUsed": "string",
        "tradeValue": 125000.5,
        "salePriceAdjustment": 125000.5,
        "qty": 1,
        "hours": 3250,
        "outputDescription": "string",
        "equipYear": "string",
        "taxableAmount": 125000.5,
        "totalSalesTax": 42,
        "suggestedList": 1.5,
        "additionalCharges": 1.5,
        "available": true,
        "requireApprovalOnSubmit": true,
        "taxExempt": false,
        "notifyCostChanged": true,
        "reasons": "string",
        "categories": "string",
        "effectiveSalePrice": 125000.5,
        "unitIdentifier": "string",
        "competitors": [
          {
            "value": "string",
            "display": "string",
            "group": "string",
            "scope": "string",
            "dateRange": true
          }
        ],
        "decisionReasons": [
          {
            "value": "string",
            "display": "string"
          }
        ],
        "wonAgainst": [
          1
        ],
        "lostTo": 1
      }
    ],
    "fields": [
      {
        "fieldName": "string",
        "label": "string",
        "internalStatus": "string",
        "visible": true,
        "required": true
      }
    ],
    "enableGrouping": true,
    "groupingLevel": "string"
  },
  "errors": []
}