salesQuotes resource type (v1.0)

NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).

Represents a salesQuote resource type 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 salesQuotessalesQuotesGets a sales quote object.
POST salesQuotessalesQuotesCreates a sales quote object.
PATCH salesQuotessalesQuotesUpdates a sales quote object.
DELETE salesQuotesnoneDeletes a sales quote object.

Bound actions

ActionReturn typeDescription
GET pdfDocumentpdfDocumentGets a PDF document.

Properties

PropertyTypeDescription
idGUIDThe quote ID. Read-Only.
numberstring, maximum size 20The quote number. Read-Only.
externalDocumentNumberstring, maximum size 35The external document number.
documentDatedateThe quote date
dueDatedateThe quote due date
customerIdGUIDThe id of the quote customer.
contactIdstring, maximum size 250The exchange contact id for the given customer. If a customer id is not specified, we will use the contact id to find it.
customerNumberstring, maximum size 20The customer number for the quote.
customerNamestring, maximum size 50The full name of the customer. Read-Only.
phoneNumberstring, maximum size 30Phone number for customer
emailstring, maximum size 80Email for customer
billingPostalAddresscomplexThe billing postal address for the quote.
currencyIdGUIDThe id of the quote currency.
currencyCodestring, maximum size 10The currency code for the quote.
paymentTermsIdGUIDThe id of the quote payment term.
paymentTermsstring, maximum size 10The payment terms of the quote.
shipmentMethodIdGUIDThe id of the quote shipment method.
shipmentMethodstring, maximum size 10The payment terms of the quote.
salespersonstring, maximum size 20The salesperson code for the quote.
discountAmountnumericThe quote discount amount
totalAmountExcludingTaxnumericThe total amount excluding tax. Read-Only.
totalTaxAmountnumericThe total tax amount for the quote. Read-Only.
totalAmountIncludingTaxnumericThe total amount for the quote, including tax. Read-Only.
statusstring, maximum size 20The quote status. Status can be: Draft,Sent,Accepted. Read-Only.
sentDatedatetimeThe date and time the quote was sent out to the customer. Read-Only.
validUntilDateDateThe date a quote is valid until.
acceptedDateDateThe date a quote is accepted. Read-Only.
billToNamestring, maximum length 100The name of the customer to bill.
billToCustomerIdGUIDId of the customer to bill
billToCustomerNumberstring, maximum length 20Number of the customer to bill.
shipToNamestring, maximum size 100Name of the customer in ship to address.
shipToContactstring, maximum size 100Ship to contact
sellingPostalAddressMicrosoft.NAV.postalAddressTypeSelling postal address
billingPostalAddressMicrosoft.NAV.postalAddressTypeBilling postal address
shippingPostalAddressMicrosoft.NAV.postalAddressTypeShipping postal address
lastModifiedDateTimedatetimeThe last datetime the sales quote was modified. Read-Only.

Relationships

A Currency(currencyCode) must exist in the Currencies table.

A Payment Term(paymentTerms) must exist in the Payment Terms table.

A Shipment Method(shipmentMethod) must exist in the Shipment Method table.

A Customer (customerId) must exist in the Customer table.

JSON representation

Here is a JSON representation of the resource.

{
      "id": "GUID",
      "number": "string",
      "externalDocumentNumber": "string",
      "documentDate": "Date",
      "dueDate": "Date",
      "customerId": "GUID",
      "contactId": "string",
      "customerNumber": "string",
      "customerName": "string",
      "billingPostalAddress": {NAV.PostalAddress},
      "currencyId": "GUID",
      "currencyCode": "string",
      "paymentTermsId": "GUID",
      "shipmentMethodId": "GUID",
      "shipmentMethod": "string",
      "salesperson": "string",
      "discountAmount": "decimal",
      "totalAmountExcludingTax": "decimal",
      "totalTaxAmount": "decimal",
      "totalAmountIncludingTax": "decimal",
      "status": "string",
      "sentDate": "DateTime",
      "validUntilDate": "Date",
      "acceptedDate": "Date",
      "lastModifiedDateTime": "DateTime"
}

Get Sales Quote
Create Sales Quote
Update Sales Quote
Delete Sales Quote