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

Method	Return Type	Description
GET salesQuote	salesQuote	Gets a sales quote object.
DELETE salesQuote	none	Deletes a sales quote object.
POST salesQuote	salesQuote	Creates a sales quote object.
PATCH salesQuote	salesQuote	Updates 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.

Navigation

Navigation	Return Type	Description
customer	customer	Gets the customer of the salesQuote.
dimensionValue	dimensionValue	Gets the dimensionvalue of the salesQuote.
currency	currency	Gets the currency of the salesQuote.
paymentTerm	paymentTerm	Gets the paymentterm of the salesQuote.
shipmentMethod	shipmentMethod	Gets the shipmentmethod of the salesQuote.
dimensionSetLines	dimensionSetLines	Gets the dimensionsetlines of the salesQuote.
salesQuoteLines	salesQuoteLines	Gets the salesquotelines of the salesQuote.
pdfDocument	pdfDocument	Gets the pdfdocument of the salesQuote.
attachments	attachments	Gets the attachments of the salesQuote.
documentAttachments	documentAttachments	Gets the documentattachments of the salesQuote.

Properties

Property	Type	Description
id	GUID	The unique ID of the sales quote. Non-editable.
number	string	Specifies the number of the sales quote.
externalDocumentNumber	string	Specifies an external document number for the sales quote.
documentDate	date	The quote date.
postingDate	date	The date that the sales quote is posted.
dueDate	date	T he date the sales quote is due.
customerId	GUID	The unique ID of customer.
customerNumber	string	The customer's number.
customerName	string	The customer's name.
billToName	string	Bill to name.
billToCustomerId	GUID	Bill to customer id.
billToCustomerNumber	string	Bill to customer number.
shipToName	string	Ship to name.
shipToContact	string	Ship to contact.
sellToAddressLine1	string	Sell to address line 1.
sellToAddressLine2	string	Sell to address line 2.
sellToCity	string	Sell to city.
sellToCountry	string	Sell to country.
sellToState	string	Sell to state.
sellToPostCode	string	Sell to post code.
billToAddressLine1	string	Bill to address line 1.
billToAddressLine2	string	Bill to address line 2.
billToCity	string	Bill to city.
billToCountry	string	Bill to country.
billToState	string	Bill to state.
billToPostCode	string	Bill to post code.
shipToAddressLine1	string	Ship to address line 1.
shipToAddressLine2	string	Ship to address line 2.
shipToCity	string	Ship to city.
shipToCountry	string	Ship to country.
shipToState	string	Ship to state.
shipToPostCode	string	Ship to post code.
shortcutDimension1Code	string
shortcutDimension2Code	string
currencyId	GUID	Specifies which currency the sales quote uses.
currencyCode	string	The default currency code for the sales quote.
paymentTermsId	GUID	Specifies which payment term the sales quote uses.
shipmentMethodId	GUID	Specifies which shipment method the sales quote uses.
salesperson	string	The salesperson code for the sales quote.
discountAmount	decimal	The sales quote discount amount.
totalAmountExcludingTax	decimal	The total amount excluding tax. Read-Only.
totalTaxAmount	decimal	The total tax amount for the sales quote. Read-Only.
totalAmountIncludingTax	decimal	The total amount including tax. Read-Only.
status	NAV.salesQuoteEntityBufferStatus	Specifies the status of the sales quote. It can be "Draft", "Sent", "Accepted" or "Expired ".
sentDate	datetime	The the date and time the quote was sent our to the customer. Read-Only.
validUntilDate	date	The date a quote is valid until.
acceptedDate	date	The date a sales quote is accepted. Read-Only.
lastModifiedDateTime	datetime	The last datetime the sales quote was modified. Read-Only.
phoneNumber	string	Specifies the sales quote's telephone number.
email	string	Specifies the sales quote's email address.

JSON representation

Here is 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"
}

See Also

GET salesQuote
DELETE salesQuote
POST salesQuote
PATCH salesQuote