API reference
All operations
SALESQUOTE

Retrieves the list of equipment associated with the specified sales quote.

Requires authentication. Returns HTTP 200 with the equipment list on success, HTTP 400 if the request is invalid, or HTTP 500 if an internal server error occurs.

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

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

salesQuoteIdpathinteger · int32required

The unique identifier of the sales quote. Must be greater than or equal to 1.

Responses

OK

Standard response envelopeisSuccessmessageerrorsdata

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

dataSalesQuoteEquipmentDto[]

An array. Each item is a SalesQuoteEquipmentDto:

  • salesQuoteIdinteger · int32
  • equipmentIdinteger · int32
  • descriptionstring
  • serialNostring
  • stockNostring
  • salePricenumber · double
  • actualSalePricenumber · double
  • finalProfitPercentnumber · double
  • finalProfitnumber · double
  • finalDiscountPercentnumber · double
  • finalDiscountnumber · double
  • minimumProfitPercentnumber · double
  • maxDiscountPercentnumber · double
  • modelIdinteger · int32
  • modelstring
  • makestring
  • inventoryIdinteger · int32
  • configurationIdinteger · int32
  • calculationTypestring
  • completeboolean
  • validboolean
  • decisionDatestring · date-timenullable
  • deliveryDatestring · date-timenullable
  • transactionTypeIdinteger · int32
  • equipmentTypeIdinteger · int32
  • saleTypeIdinteger · int32
  • tradeOverallowancenumber · double
  • transactionTypestring
  • saleTypestring
  • equipmentTypestring
  • decisionCommentsstring
  • financeCommentsstring
  • thresholdExceededboolean
  • closedStatusIdinteger · int32
  • dealIdinteger · int32
  • dealTrackerRequestStatusstring
  • dealIdentifierstring
  • newUsedstring
  • tradeValuenumber · double
  • salePriceAdjustmentnumber · double
  • qtyinteger · int32
  • hoursinteger · int32
  • outputDescriptionstring
  • equipYearstring
  • taxableAmountnumber · double
  • totalSalesTaxnumber · double
  • suggestedListnumber · double
  • additionalChargesnumber · double
  • availableboolean
  • requireApprovalOnSubmitboolean
  • taxExemptboolean
  • notifyCostChangedboolean
  • reasonsstring
  • categoriesstring
  • effectiveSalePricenumber · double
  • unitIdentifierstring
  • wonAgainstinteger[]
  • lostTointeger · int32