Skip to main content

Sales endpoints

Customers, open and posted sales documents, archives, customer ledger entries, prices, and the CRM side of Business Central: contacts, campaigns, opportunities and interactions.

All URLs on this page are relative to the company URL, https://api.businesscentral.dynamics.com/v2.0/{tenantId}/{environment}/api/datawareness/endpoints/v1.0/companies({companyId})/. See Construction of the URL.

Master data​

EndpointDescriptionBusiness keySource tableTier
campaignsMarketing campaigns.noCampaignPremium
closeOpportunityCodesReason codes for closing opportunities.codeClose Opportunity CodePremium
contactBusinessRelationsContact to business relations mapping.contactNo&&businessRelationCodeContact Business RelationPremium
contactsContact master data.noContactPremium
customerDimensionsDefault dimensions assigned to customers.customerNo&&dimensionCodeDefault DimensionPremium
customerPostingGroupsCustomer posting group definitions.codeCustomer Posting GroupPremium
customerPriceGroupsCustomer price group definitions.codeCustomer Price GroupPremium
customersCustomer master data.noCustomerFree
interactionGroupsInteraction group definitions.codeInteraction GroupPremium
interactionTemplatesInteraction template definitions.codeInteraction TemplatePremium
priceListHeadersPrice list headers (BC 16+ price calculation).codePrice List HeaderPremium
priceListLinesPrice list lines: sales/purchase prices and discounts per item, resource, resource group or G/L account.priceListCode&&lineNoPrice List LinePremium
profileQuestionnaireLinesProfile questionnaire lines (questions used for contact classification).profileQuestionnaireCode&&lineNoProfile Questionnaire LinePremium
salesCyclesSales process (cycle) definitions.codeSales CyclePremium
salesCycleStagesStages within a sales cycle.salesCycleCode&&stageSales Cycle StagePremium
salespersonsPurchasersSalesperson/purchaser master data.codeSalesperson/PurchaserPremium
shipmentMethodsShipment method definitions.codeShipment MethodPremium

Transactional data​

EndpointDescriptionBusiness keySource tableTier
contactProfileAnswersProfile questionnaire answers selected per contact.contactNo&&profileQuestionnaireCode&&lineNoContact Profile AnswerPremium
customerLedgerEntriesCustomer ledger entries.entryNoCust. Ledger EntryPremium
interactionLogEntriesInteraction log entries (CRM activity history).entryNoInteraction Log EntryPremium
opportunitiesSales opportunities (leads).noOpportunityPremium
opportunityEntriesStage history for sales opportunities.entryNoOpportunity EntryPremium
salesCommentLineArchivesArchived comments on sales documents.documentType&&no&&docNoOccurrence&&versionNo&&documentLineNo&&lineNoSales Comment Line ArchivePremium
salesCommentLinesComments on sales documents.documentType&&no&&documentLineNo&&lineNoSales Comment LinePremium
salesCreditMemoHeadersPosted sales credit memo headers.noSales Cr.Memo HeaderPremium
salesCreditMemoLinesPosted sales credit memo lines.documentNo&&lineNoSales Cr.Memo LinePremium
salesHeaderArchivesArchived sales headers.documentType&&no&&docNoOccurrence&&versionNoSales Header ArchivePremium
salesHeadersSales headers (quotes, orders, invoices, credit memos, etc.).documentType&&noSales HeaderPremium
salesInvoiceHeadersPosted sales invoice headers.noSales Invoice HeaderPremium
salesInvoiceLinesPosted sales invoice lines.documentNo&&lineNoSales Invoice LinePremium
salesInvoicesDenormalized posted sales invoices combining header and line data.documentNo&&lineNoSales Invoice LineFree
salesLineArchivesArchived sales lines.documentType&&documentNo&&docNoOccurrence&&versionNo&&lineNoSales Line ArchivePremium
salesLinesSales lines.documentType&&documentNo&&lineNoSales LinePremium

Example queries​

Posted sales invoices for a quarter​

GET .../salesInvoiceHeaders?$filter=postingDate ge 2026-01-01 and postingDate le 2026-03-31
&$select=no,sellToCustomerNo,postingDate,currencyCode,amount,amountIncludingVAT

Customers in one country​

GET .../customers?$filter=countryRegionCode eq 'DK'
&$select=no,name,city,salespersonCode,balanceLCY

Open receivables​

GET .../customerLedgerEntries?$filter=open eq true
&$select=entryNo,customerNo,documentNo,postingDate,dueDate,remainingAmtLCY

Opportunities created this year​

GET .../opportunities?$filter=creationDate ge 2026-01-01
&$select=no,description,contactNo,salespersonCode,salesCycleCode,status

Tips​

  • Free tier: customers and salesInvoices are available without a Premium subscription. salesInvoices combines posted invoice header and line data in one row per line, ready for a simple sales report.
  • Headers and lines: join salesInvoiceLines.documentNo to salesInvoiceHeaders.no, and salesLines to salesHeaders on documentType and documentNo.
  • Fields: every endpoint's fields, with types, are listed by properties — see Metadata discovery. The same list is on the endpoint's page under BI Endpoints in Business Central.