Purchasing endpoints
Vendors, open and posted purchase documents, archives, and vendor ledger entries.
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
| Endpoint | Description | Business key | Source table | Tier |
|---|---|---|---|---|
vendorDimensions | Default dimensions assigned to vendors. | vendorNo&&dimensionCode | Default Dimension | Premium |
vendorPostingGroups | Vendor posting group definitions. | code | Vendor Posting Group | Premium |
vendors | Vendor master data. | no | Vendor | Premium |
Transactional data
| Endpoint | Description | Business key | Source table | Tier |
|---|---|---|---|---|
purchaseCreditMemoHeaders | Posted purchase credit memo headers. | no | Purch. Cr. Memo Hdr. | Premium |
purchaseCreditMemoLines | Posted purchase credit memo lines. | documentNo&&lineNo | Purch. Cr. Memo Line | Premium |
purchaseHeaderArchives | Archived purchase headers. | documentType&&no&&docNoOccurrence&&versionNo | Purchase Header Archive | Premium |
purchaseHeaders | Purchase headers (quotes, orders, invoices, credit memos, etc.). | documentType&&no | Purchase Header | Premium |
purchaseInvoiceHeaders | Posted purchase invoice headers. | no | Purch. Inv. Header | Premium |
purchaseInvoiceLines | Posted purchase invoice lines. | documentNo&&lineNo | Purch. Inv. Line | Premium |
purchaseLineArchives | Archived purchase lines. | documentType&&documentNo&&docNoOccurrence&&versionNo&&lineNo | Purchase Line Archive | Premium |
purchaseLines | Purchase lines. | documentType&&documentNo&&lineNo | Purchase Line | Premium |
vendorLedgerEntries | Vendor ledger entries. | entryNo | Vendor Ledger Entry | Premium |
Example queries
Posted purchase invoices since a date
GET .../purchaseInvoiceHeaders?$filter=postingDate ge 2026-01-01
&$select=no,buyFromVendorNo,postingDate,vendorInvoiceNo,currencyCode,purchaserCode
Lines of one posted purchase invoice
GET .../purchaseInvoiceLines?$filter=documentNo eq 'PPI-108001'
&$select=documentNo,lineNo,type,no,description,quantity,lineAmount
Open payables
GET .../vendorLedgerEntries?$filter=open eq true
&$select=entryNo,vendorNo,documentNo,postingDate,dueDate,remainingAmtLCY
Tips
- Headers and lines: join
purchaseInvoiceLines.documentNotopurchaseInvoiceHeaders.no, andpurchaseLinestopurchaseHeadersondocumentTypeanddocumentNo. - 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.