Business Central API v2.0

company-account

accounts account trialBalance

company-accountingPeriods

accountingPeriods accountingPeriod

company-aged accounts payable

agedAccountsPayables agedAccountsPayable vendor

company-aged accounts receivable

agedAccountsReceivables agedAccountsReceivable customer

company-FIX: apply vendor entry

applyVendorEntry applyVendorEntry Copy applyVendorEntry

company-UPDATE: attachments

company-balance sheet

balanceSheets balanceSheet

company-bank account

bankAccounts bankAccount bankAccount bankAccount bankAccount

company-cash flow statement

cashFlowStatements cashFlowStatement

company-company information

companyInformation companyInformation

company-contact

contacts contact contact contact contact contactInformation picture

company-contact information

contactsInformation customer contactInformation vendor contactInformation vendor contactInformation Copy

company-country/region

countriesRegions countriesRegion countriesRegion countriesRegion countriesRegion

company-currency

currencies currency currency currency currency

company-currency exchange rate

currencyExchangeRates currencyExchangeRate

company-customer

customers customer customer customer customer paymentTerm shipmentMethod customerFinancialDetail picture defaultDimension agedAccountsReceivable contactsInformation

company-customer financial detail

customerFinancialDetails customerFinancialDetail customers/customerFinancialDetail customer(id)/customerFinancialDetail

company-customer payment

customerPayments customerPayment customerPayment customerPayment customerPayment

company-customer payment journal

customerPaymentJournals customerPaymentJournal customerPaymentJournal customerPaymentJournal customerPaymentJournal

company-customer return reason

customerReturnReasons customerReturnReason customerReturnReason customerReturnReason customerReturnReason

company-customer sale

customerSales $filter

company-default dimensions

defaultDimensions defaultDimension defaultDimension defaultDimension defaultDimension dimension dimensionValue

company-dimension

dimensions dimension

company-UPDATE: dimension set line

dimensionSetLines dimensionSetLine dimensionSetLine dimensionSetLine dimensionSetLine

company-dimension value

dimensionValues dimensionValue

company-dispute status

disputeStatus disputeStatus disputeStatus disputeStatus disputeStatus

company-TODO document attachment

documentAttachments documentAttachment documentAttachment documentAttachment documentAttachment

company-employee

employees employee employee employee employee defaultDimensions picture timeRegistrationEntries

company-FIX external business definition

externalBusinessDefinition

company-FIX external event subscription

externalEventSubscription externalEventSubscription Copy

company-fixed asset

fixedAssets fixedAsset fixedAsset fixedAsset fixedAsset employee fixedAssetLocation

company-fixed asset location

fixedAssetLocations fixedAssetLocation fixedAssetLocation fixedAssetLocation fixedAssetLocation

company-general ledger entry

generalLedgerEntries generalLedgerEntry account attachments dimensionSetLines

company-general ledger setup

generalLedgerSetups generalLedgerSetup

company-general product posting group

generalProductPostingGroups generalProductPostingGroup

company-income statement

incomeStatements incomeStatement

company-inventory posting group

inventoryPostingGroups inventoryPostingGroup

items item item item item itemCategory unitOfMeasure inventoryPostingGroup generalProductPostingGroup itemVariants defaultDimensions picture

company-item category

itemCategories itemCategory itemCategories itemCategories itemCategories

company-item ledger entry

itemLedgerEntries itemLedgerEntry item customer

company-item variant

itemVariants itemVariant itemVariant itemVariant itemVariant

company-journal

journals journal journal journal journal

company-journal line

journalLines journalLine journalLine journalLine journalLine

company-location

locations location location location location

company-opportunity

opportunities opportunity opportunity opportunity opportunity contact

company-payment method

paymentMethods paymentMethod paymentMethod paymentMethod paymentMethod

company-payment term

paymentTerms paymentTerm paymentTerm paymentTerm paymentTerm

company-pdf document

salesInvoice pdfDocument salesInvoice pdfDocumentContent salesQuote pdfDocument salesQuote pdfDocumentContent salesCreditMemo pdfDocument salesCreditMemo pdfDocumentContent purchaseInvoice pdfDocument purchaseInvoice pdfDocumentContent

company-picture

item picture item picture item picture item pictureContent employee picture vendor picture customer picture contact picture

company-project

projects project project project project documentAttachments

company-purchase credit memo

purchaseCreditMemos purchaseCreditMemo purchaseCreditMemo purchaseCreditMemo purchaseCreditMemo attachments currency customerReturnReason dimensionSetLines dimensionValue documentAttachments paymentTerm shipmentMethod pdfDocument vendor Microsoft.NAV.cancel Microsoft.NAV.post

company-purchase credit memo line

purchaseCreditMemoLines purchaseCreditMemoLine purchaseCreditMemoLine purchaseCreditMemoLine purchaseCreditMemoLine account dimensionSetLines item itemVariant location unitOfMeasure

company-purchase invoice

purchaseInvoices purchaseInvoice purchaseInvoice purchaseInvoice purchaseInvoice attachments countryRegion currency dimensionSetLines dimensionValue documentAttachments pdfDocument vendor Microsoft.NAV.post

company-purchase invoice line

purchaseInvoiceLines purchaseInvoiceLine purchaseInvoiceLine purchaseInvoiceLine purchaseInvoiceLine account dimensionSetLines item itemVariant location unitOfMeasure

company-NAVDOC: purchase order

purchaseOrders purchaseOrder DOC: purchaseOrder purchaseOrder purchaseOrder

company-UPDATE: purchase order line

purchaseOrderLines purchaseOrderLine DOC: purchaseOrderLine purchaseOrderLine purchaseOrderLine account dimensionSetLines item itemVariant location unitOfMeasure

company-UPDATE: purchase receipt

purchaseReceipts purchaseReceipt dimensionSetLines DOC: vendor DOC: countryRegion

company-UPDATE: purchase receipt line

purchaseReceiptLines purchaseReceiptLine DOC: account dimensionSetLines

company-retained earnings statement

retainedEarningsStatements

company-sales credit memo

salesCreditMemos salesCreditMemo salesCreditMemo salesCreditMemo salesCreditMemo attachments countryRegion currency customer customerReturnReason dimensionSetLines dimensionValue paymentTerm pdfDocument shipmentMethod

company-sales credit memo line

salesCreditMemoLines salesCreditMemoLine salesCreditMemoLine salesCreditMemoLine salesCreditMemoLine account dimensionSetLines item itemVariant location unitOfMeasure Microsoft.NAV.cancel Microsoft.NAV.cancelAndSend Microsoft.NAV.postAndSend Microsoft.NAV.post Microsoft.NAV.send

company-sales invoice

salesInvoices salesInvoice salesInvoice salesInvoice salesInvoice dimensionSetLines pdfDocument

company-sales invoice line

salesInvoiceLines salesInvoiceLine salesInvoiceLine salesInvoiceLine salesInvoiceLine

company-sales order

salesOrders salesOrder salesOrder salesOrder salesOrder dimensionSetLines

company-sales order line

salesOrderLines salesOrderLine salesOrderLine salesOrderLine salesOrderLine

company-sales quote

salesQuotes salesQuote salesQuote salesQuote salesQuote pdfDocument

company-sales quote line

salesQuoteLines salesQuoteLine salesQuoteLine salesQuoteLine salesQuoteLine

company-sales shipment

salesShipments salesShipment customer countryRegion dimensionSetLines paymentTerm shipmentMethod

company-sales shipment line

salesShipmentLines salesShipmentLine account dimensionSetLines

company-shipment method

shipmentMethods shipmentMethod shipmentMethod shipmentMethod shipmentMethod

company-subscriptions

subscriptions subscription subscription subscription subscription

company-tax area

taxAreas taxArea taxArea taxArea taxArea

company-tax group

taxGroups taxGroup taxGroup taxGroup taxGroup

company-time registration entry

timeRegistrationEntries timeRegistrationEntry timeRegistrationEntry timeRegistrationEntry timeRegistrationEntry

company-trial balance

trialBalances trialBalance

company-unit of measure

unitsOfMeasures unitsOfMeasure unitsOfMeasure unitsOfMeasure unitsOfMeasure

vendors vendor vendor vendor vendor agedAccountsPayable contactsInformation defaultDimensions paymentMethod paymentTerm picture

company-vendor payment

vendorPayments vendorPayment vendorPayment vendorPayment vendorPayment

company-vendor payment journal

vendorPaymentJournals vendorPaymentJournal vendorPaymentJournal vendorPaymentJournal vendorPaymentJournal account vendorPayments

company-vendor purchase

vendorPurchase $filter vendorPurchase

companies company

metadata metadata schemaversion

Business Central API v2.0

company-account

accounts account trialBalance

company-accountingPeriods

accountingPeriods accountingPeriod

company-aged accounts payable

agedAccountsPayables agedAccountsPayable vendor

company-aged accounts receivable

agedAccountsReceivables agedAccountsReceivable customer

company-FIX: apply vendor entry

applyVendorEntry applyVendorEntry Copy applyVendorEntry

company-UPDATE: attachments

company-balance sheet

balanceSheets balanceSheet

company-bank account

bankAccounts bankAccount bankAccount bankAccount bankAccount

company-cash flow statement

cashFlowStatements cashFlowStatement

company-company information

companyInformation companyInformation

company-contact

contacts contact contact contact contact contactInformation picture

company-contact information

contactsInformation customer contactInformation vendor contactInformation vendor contactInformation Copy

company-country/region

countriesRegions countriesRegion countriesRegion countriesRegion countriesRegion

company-currency

currencies currency currency currency currency

company-currency exchange rate

currencyExchangeRates currencyExchangeRate

company-customer

customers customer customer customer customer paymentTerm shipmentMethod customerFinancialDetail picture defaultDimension agedAccountsReceivable contactsInformation

company-customer financial detail

customerFinancialDetails customerFinancialDetail customers/customerFinancialDetail customer(id)/customerFinancialDetail

company-customer payment

customerPayments customerPayment customerPayment customerPayment customerPayment

company-customer payment journal

customerPaymentJournals customerPaymentJournal customerPaymentJournal customerPaymentJournal customerPaymentJournal

company-customer return reason

customerReturnReasons customerReturnReason customerReturnReason customerReturnReason customerReturnReason

company-customer sale

customerSales $filter

company-default dimensions

defaultDimensions defaultDimension defaultDimension defaultDimension defaultDimension dimension dimensionValue

company-dimension

dimensions dimension

company-UPDATE: dimension set line

dimensionSetLines dimensionSetLine dimensionSetLine dimensionSetLine dimensionSetLine

company-dimension value

dimensionValues dimensionValue

company-dispute status

disputeStatus disputeStatus disputeStatus disputeStatus disputeStatus

company-TODO document attachment

documentAttachments documentAttachment documentAttachment documentAttachment documentAttachment

company-employee

employees employee employee employee employee defaultDimensions picture timeRegistrationEntries

company-FIX external business definition

externalBusinessDefinition

company-FIX external event subscription

externalEventSubscription externalEventSubscription Copy

company-fixed asset

fixedAssets fixedAsset fixedAsset fixedAsset fixedAsset employee fixedAssetLocation

company-fixed asset location

fixedAssetLocations fixedAssetLocation fixedAssetLocation fixedAssetLocation fixedAssetLocation

company-general ledger entry

generalLedgerEntries generalLedgerEntry account attachments dimensionSetLines

company-general ledger setup

generalLedgerSetups generalLedgerSetup

company-general product posting group

generalProductPostingGroups generalProductPostingGroup

company-income statement

incomeStatements incomeStatement

company-inventory posting group

inventoryPostingGroups inventoryPostingGroup

items item item item item itemCategory unitOfMeasure inventoryPostingGroup generalProductPostingGroup itemVariants defaultDimensions picture

company-item category

itemCategories itemCategory itemCategories itemCategories itemCategories

company-item ledger entry

itemLedgerEntries itemLedgerEntry item customer

company-item variant

itemVariants itemVariant itemVariant itemVariant itemVariant

company-journal

journals journal journal journal journal

company-journal line

journalLines journalLine journalLine journalLine journalLine

company-location

locations location location location location

company-opportunity

opportunities opportunity opportunity opportunity opportunity contact

company-payment method

paymentMethods paymentMethod paymentMethod paymentMethod paymentMethod

company-payment term

paymentTerms paymentTerm paymentTerm paymentTerm paymentTerm

company-pdf document

salesInvoice pdfDocument salesInvoice pdfDocumentContent salesQuote pdfDocument salesQuote pdfDocumentContent salesCreditMemo pdfDocument salesCreditMemo pdfDocumentContent purchaseInvoice pdfDocument purchaseInvoice pdfDocumentContent

company-picture

item picture item picture item picture item pictureContent employee picture vendor picture customer picture contact picture

company-project

projects project project project project documentAttachments

company-purchase credit memo

purchaseCreditMemos purchaseCreditMemo purchaseCreditMemo purchaseCreditMemo purchaseCreditMemo attachments currency customerReturnReason dimensionSetLines dimensionValue documentAttachments paymentTerm shipmentMethod pdfDocument vendor Microsoft.NAV.cancel Microsoft.NAV.post

company-purchase credit memo line

purchaseCreditMemoLines purchaseCreditMemoLine purchaseCreditMemoLine purchaseCreditMemoLine purchaseCreditMemoLine account dimensionSetLines item itemVariant location unitOfMeasure

company-purchase invoice

purchaseInvoices purchaseInvoice purchaseInvoice purchaseInvoice purchaseInvoice attachments countryRegion currency dimensionSetLines dimensionValue documentAttachments pdfDocument vendor Microsoft.NAV.post

company-purchase invoice line

purchaseInvoiceLines purchaseInvoiceLine purchaseInvoiceLine purchaseInvoiceLine purchaseInvoiceLine account dimensionSetLines item itemVariant location unitOfMeasure

company-NAVDOC: purchase order

purchaseOrders purchaseOrder DOC: purchaseOrder purchaseOrder purchaseOrder

company-UPDATE: purchase order line

purchaseOrderLines purchaseOrderLine DOC: purchaseOrderLine purchaseOrderLine purchaseOrderLine account dimensionSetLines item itemVariant location unitOfMeasure

company-UPDATE: purchase receipt

purchaseReceipts purchaseReceipt dimensionSetLines DOC: vendor DOC: countryRegion

company-UPDATE: purchase receipt line

purchaseReceiptLines purchaseReceiptLine DOC: account dimensionSetLines

company-retained earnings statement

retainedEarningsStatements

company-sales credit memo

salesCreditMemos salesCreditMemo salesCreditMemo salesCreditMemo salesCreditMemo attachments countryRegion currency customer customerReturnReason dimensionSetLines dimensionValue paymentTerm pdfDocument shipmentMethod

company-sales credit memo line

salesCreditMemoLines salesCreditMemoLine salesCreditMemoLine salesCreditMemoLine salesCreditMemoLine account dimensionSetLines item itemVariant location unitOfMeasure Microsoft.NAV.cancel Microsoft.NAV.cancelAndSend Microsoft.NAV.postAndSend Microsoft.NAV.post Microsoft.NAV.send

company-sales invoice

salesInvoices salesInvoice salesInvoice salesInvoice salesInvoice dimensionSetLines pdfDocument

company-sales invoice line

salesInvoiceLines salesInvoiceLine salesInvoiceLine salesInvoiceLine salesInvoiceLine

company-sales order

salesOrders salesOrder salesOrder salesOrder salesOrder dimensionSetLines

company-sales order line

salesOrderLines salesOrderLine salesOrderLine salesOrderLine salesOrderLine

company-sales quote

salesQuotes salesQuote salesQuote salesQuote salesQuote pdfDocument

company-sales quote line

salesQuoteLines salesQuoteLine salesQuoteLine salesQuoteLine salesQuoteLine

company-sales shipment

salesShipments salesShipment customer countryRegion dimensionSetLines paymentTerm shipmentMethod

company-sales shipment line

salesShipmentLines salesShipmentLine account dimensionSetLines

company-shipment method

shipmentMethods shipmentMethod shipmentMethod shipmentMethod shipmentMethod

company-subscriptions

subscriptions subscription subscription subscription subscription

company-tax area

taxAreas taxArea taxArea taxArea taxArea

company-tax group

taxGroups taxGroup taxGroup taxGroup taxGroup

company-time registration entry

timeRegistrationEntries timeRegistrationEntry timeRegistrationEntry timeRegistrationEntry timeRegistrationEntry

company-trial balance

trialBalances trialBalance

company-unit of measure

unitsOfMeasures unitsOfMeasure unitsOfMeasure unitsOfMeasure unitsOfMeasure

vendors vendor vendor vendor vendor agedAccountsPayable contactsInformation defaultDimensions paymentMethod paymentTerm picture

company-vendor payment

vendorPayments vendorPayment vendorPayment vendorPayment vendorPayment

company-vendor payment journal

vendorPaymentJournals vendorPaymentJournal vendorPaymentJournal vendorPaymentJournal vendorPaymentJournal account vendorPayments

company-vendor purchase

vendorPurchase $filter vendorPurchase

companies company

metadata metadata schemaversion

Home Business Central API v2.0metadata

metadata

GET {{url}}/{{environment}}/api/v2.0/$metadata?tenant={{tenant}}

Request Params

Key	Datatype	Required	Description
`tenant`	string

metadata schemaversion