salesQuote resource type

Represents a sales quote in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET salesQuotesalesQuoteGets a sales quote object.
DELETE salesQuotenoneDeletes a sales quote object.
POST salesQuotesalesQuoteCreates a sales quote object.
PATCH salesQuotesalesQuoteUpdates a sales quote object.

Bound actions

The salesQuote resource type offers a bound action called send, which sends the corresponding salesQuote batch. This is illustrated in the following example: SEND https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesQuotes({id})/Microsoft.NAV.send

The response has no content; the response code is 204.

The salesQuote resource type offers a bound action called makeInvoice which make invoices the corresponding salesQuote batch. This is illustrated in the following example: MAKEINVOICE https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesQuotes({id})/Microsoft.NAV.makeInvoice

The response has no content; the response code is 204.

The salesQuote resource type offers a bound action called makeOrder which make orders the corresponding salesQuote batch. This is illustrated in the following example: MAKEORDER https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/salesQuotes({id})/Microsoft.NAV.makeOrder

The response has no content; the response code is 204.

NavigationReturn TypeDescription
customercustomerGets the customer of the salesQuote.
dimensionValuedimensionValueGets the dimensionvalue of the salesQuote.
currencycurrencyGets the currency of the salesQuote.
paymentTermpaymentTermGets the paymentterm of the salesQuote.
shipmentMethodshipmentMethodGets the shipmentmethod of the salesQuote.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the salesQuote.
salesQuoteLinessalesQuoteLinesGets the salesquotelines of the salesQuote.
pdfDocumentpdfDocumentGets the pdfdocument of the salesQuote.
attachmentsattachmentsGets the attachments of the salesQuote.
documentAttachmentsdocumentAttachmentsGets the documentattachments of the salesQuote.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sales quote. Non-editable.
numberstringSpecifies the number of the sales quote.
externalDocumentNumberstringSpecifies an external document number for the sales quote.
documentDatedateThe quote date.
postingDatedateThe date that the sales quote is posted.
dueDatedateT he date the sales quote is due.
customerIdGUIDThe unique ID of customer.
customerNumberstringThe customer's number.
customerNamestringThe customer's name.
billToNamestringBill to name.
billToCustomerIdGUIDBill to customer id.
billToCustomerNumberstringBill to customer number.
shipToNamestringShip to name.
shipToContactstringShip to contact.
sellToAddressLine1stringSell to address line 1.
sellToAddressLine2stringSell to address line 2.
sellToCitystringSell to city.
sellToCountrystringSell to country.
sellToStatestringSell to state.
sellToPostCodestringSell to post code.
billToAddressLine1stringBill to address line 1.
billToAddressLine2stringBill to address line 2.
billToCitystringBill to city.
billToCountrystringBill to country.
billToStatestringBill to state.
billToPostCodestringBill to post code.
shipToAddressLine1stringShip to address line 1.
shipToAddressLine2stringShip to address line 2.
shipToCitystringShip to city.
shipToCountrystringShip to country.
shipToStatestringShip to state.
shipToPostCodestringShip to post code.
shortcutDimension1Codestring
shortcutDimension2Codestring
currencyIdGUIDSpecifies which currency the sales quote uses.
currencyCodestringThe default currency code for the sales quote.
paymentTermsIdGUIDSpecifies which payment term the sales quote uses.
shipmentMethodIdGUIDSpecifies which shipment method the sales quote uses.
salespersonstringThe salesperson code for the sales quote.
discountAmountdecimalThe sales quote discount amount.
totalAmountExcludingTaxdecimalThe total amount excluding tax. Read-Only.
totalTaxAmountdecimalThe total tax amount for the sales quote. Read-Only.
totalAmountIncludingTaxdecimalThe total amount including tax. Read-Only.
statusNAV.salesQuoteEntityBufferStatusSpecifies the status of the sales quote. It can be "Draft", "Sent", "Accepted" or "Expired ".
sentDatedatetimeThe date and time the quote was sent out to the customer. Read-Only.
validUntilDatedateThe date a quote is valid until.
acceptedDatedateThe date a sales quote is accepted. Read-Only.
lastModifiedDateTimedatetimeThe last datetime the sales quote was modified. Read-Only.
phoneNumberstringSpecifies the sales quote's telephone number.
emailstringSpecifies the sales quote's email address.

JSON representation

Here's a JSON representation of the salesQuote resource.

{
    "id": "GUID",
    "number": "string",
    "externalDocumentNumber": "string",
    "documentDate": "date",
    "postingDate": "date",
    "dueDate": "date",
    "customerId": "GUID",
    "customerNumber": "string",
    "customerName": "string",
    "billToName": "string",
    "billToCustomerId": "GUID",
    "billToCustomerNumber": "string",
    "shipToName": "string",
    "shipToContact": "string",
    "sellToAddressLine1": "string",
    "sellToAddressLine2": "string",
    "sellToCity": "string",
    "sellToCountry": "string",
    "sellToState": "string",
    "sellToPostCode": "string",
    "billToAddressLine1": "string",
    "billToAddressLine2": "string",
    "billToCity": "string",
    "billToCountry": "string",
    "billToState": "string",
    "billToPostCode": "string",
    "shipToAddressLine1": "string",
    "shipToAddressLine2": "string",
    "shipToCity": "string",
    "shipToCountry": "string",
    "shipToState": "string",
    "shipToPostCode": "string",
    "shortcutDimension1Code": "string",
    "shortcutDimension2Code": "string",
    "currencyId": "GUID",
    "currencyCode": "string",
    "paymentTermsId": "GUID",
    "shipmentMethodId": "GUID",
    "salesperson": "string",
    "discountAmount": "decimal",
    "totalAmountExcludingTax": "decimal",
    "totalTaxAmount": "decimal",
    "totalAmountIncludingTax": "decimal",
    "status": "NAV.salesQuoteEntityBufferStatus",
    "sentDate": "datetime",
    "validUntilDate": "date",
    "acceptedDate": "date",
    "lastModifiedDateTime": "datetime",
    "phoneNumber": "string",
    "email": "string"
}

GET salesQuote
DELETE salesQuote
POST salesQuote
PATCH salesQuote