(v1.0) Dynamics 365 Business Central

Business management and ERP solution

learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api ↗
Version
1.0.0
OpenAPI
3.0.0
Endpoints
324
Schemas
162
71
Quality
Updated
3 days ago
Erp erp business microsoft
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v1.0
https://api.businesscentral.dynamics.com/v2.0/production/api/v1.0

Endpoints

Clear filters

Attachments 3 endpoints

POST /companies({company_id})/attachments
operationId: Attachments_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema AttachmentsCreateD365ObjectRequest

Responses

201

(v1.0) A new attachments has been succesfully created

POST /companies({company_id})/attachments
POST /companies({company_id})/journalLines({journalLine_id})/attachments
operationId: Attachments_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

journalLine_id path required string

(v1.0) id for journalLine

Request Body

application/json
schema AttachmentsCreateD365ObjectRequest

Responses

201

(v1.0) A new attachments has been succesfully created

POST /companies({company_id})/journalLines({journalLine_id})/attachments
POST /companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments
operationId: Attachments_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

journal_id path required string

(v1.0) id for journal

journalLine_id path required string

(v1.0) id for journalLine

Request Body

application/json
schema AttachmentsCreateD365ObjectRequest

Responses

201

(v1.0) A new attachments has been succesfully created

POST /companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments

Bankaccount 1 endpoints

POST /companies({company_id})/bankAccounts
operationId: BankAccount_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema BankAccountCreateDynamicsObjectRequest

Responses

201

(v1.0) A new bankAccount has been succesfully created

POST /companies({company_id})/bankAccounts

Countryregion 1 endpoints

POST /companies({company_id})/countriesRegions
operationId: CountryRegion_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema CountryRegionCreateDynamicsObjectRequest

Responses

201

(v1.0) A new countryRegion has been succesfully created

POST /companies({company_id})/countriesRegions

Currency 1 endpoints

POST /companies({company_id})/currencies
operationId: Currency_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema CurrencyCreateDynamicsObjectRequest

Responses

201

(v1.0) A new currency has been succesfully created

POST /companies({company_id})/currencies

Customer 1 endpoints

POST /companies({company_id})/customers
operationId: Customer_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema CustomerCreateDynamicsObjectRequest

Responses

201

(v1.0) A new customer has been succesfully created

POST /companies({company_id})/customers

Customerpayment 2 endpoints

POST /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments
operationId: CustomerPayment_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

customerPaymentJournal_id path required string

(v1.0) id for customerPaymentJournal

Request Body

application/json
schema CustomerPaymentCreateD365ObjectRequest

Responses

201

(v1.0) A new customerPayment has been succesfully created

POST /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments
POST /companies({company_id})/customerPayments
operationId: CustomerPayment_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema CustomerPaymentCreateD365ObjectRequest

Responses

201

(v1.0) A new customerPayment has been succesfully created

POST /companies({company_id})/customerPayments

Customerpaymentjournal 1 endpoints

POST /companies({company_id})/customerPaymentJournals
operationId: CustomerPaymentJournal_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema CustomerPaymentJournalCreateDynamicsObjectRequest

Responses

201

(v1.0) A new customerPaymentJournal has been succesfully created

POST /companies({company_id})/customerPaymentJournals

Defaultdimensions 5 endpoints

POST /companies({company_id})/customers({customer_id})/defaultDimensions
operationId: DefaultDimensions_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

customer_id path required string

(v1.0) id for customer

Request Body

application/json
schema DefaultDimensionsCreateDynamicsObjectRequest

Responses

201

(v1.0) A new defaultDimensions has been succesfully created

POST /companies({company_id})/customers({customer_id})/defaultDimensions
POST /companies({company_id})/defaultDimensions
operationId: DefaultDimensions_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema DefaultDimensionsCreateDynamicsObjectRequest

Responses

201

(v1.0) A new defaultDimensions has been succesfully created

POST /companies({company_id})/defaultDimensions
POST /companies({company_id})/employees({employee_id})/defaultDimensions
operationId: DefaultDimensions_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

employee_id path required string

(v1.0) id for employee

Request Body

application/json
schema DefaultDimensionsCreateDynamicsObjectRequest

Responses

201

(v1.0) A new defaultDimensions has been succesfully created

POST /companies({company_id})/employees({employee_id})/defaultDimensions
POST /companies({company_id})/items({item_id})/defaultDimensions
operationId: DefaultDimensions_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

item_id path required string

(v1.0) id for item

Request Body

application/json
schema DefaultDimensionsCreateDynamicsObjectRequest

Responses

201

(v1.0) A new defaultDimensions has been succesfully created

POST /companies({company_id})/items({item_id})/defaultDimensions
POST /companies({company_id})/vendors({vendor_id})/defaultDimensions
operationId: DefaultDimensions_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

vendor_id path required string

(v1.0) id for vendor

Request Body

application/json
schema DefaultDimensionsCreateDynamicsObjectRequest

Responses

201

(v1.0) A new defaultDimensions has been succesfully created

POST /companies({company_id})/vendors({vendor_id})/defaultDimensions

Dimensionline 1 endpoints

POST /companies({company_id})/dimensionLines
operationId: DimensionLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema DimensionLineCreateD365ObjectRequest

Responses

201

(v1.0) A new dimensionLine has been succesfully created

POST /companies({company_id})/dimensionLines

Employee 1 endpoints

POST /companies({company_id})/employees
operationId: Employee_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema EmployeeCreateDynamicsObjectRequest

Responses

201

(v1.0) A new employee has been succesfully created

POST /companies({company_id})/employees

Generalledgerentryattachments 1 endpoints

POST /companies({company_id})/generalLedgerEntryAttachments
operationId: GeneralLedgerEntryAttachments_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema GeneralLedgerEntryAttachmentsCreateD365ObjectRequest

Responses

201

(v1.0) A new generalLedgerEntryAttachments has been succesfully created

POST /companies({company_id})/generalLedgerEntryAttachments

Item 1 endpoints

POST /companies({company_id})/items
operationId: Item_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema ItemCreateDynamicsObjectRequest

Responses

201

(v1.0) A new item has been succesfully created

POST /companies({company_id})/items

Itemcategory 1 endpoints

POST /companies({company_id})/itemCategories
operationId: ItemCategory_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema ItemCategoryCreateD365ObjectRequest

Responses

201

(v1.0) A new itemCategory has been succesfully created

POST /companies({company_id})/itemCategories

Journal 2 endpoints

POST /companies({company_id})/journals
operationId: Journal_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema JournalCreateDynamicsObjectRequest

Responses

201

(v1.0) A new journal has been succesfully created

POST /companies({company_id})/journals
POST /companies({company_id})/journals({journal_id})/Microsoft.NAV.post
operationId: Journal_postAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

journal_id path required string

(v1.0) id for journal

Responses

204

(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central journals entity

POST /companies({company_id})/journals({journal_id})/Microsoft.NAV.post

Journalline 2 endpoints

POST /companies({company_id})/journalLines
operationId: JournalLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema JournalLineCreateD365ObjectRequest

Responses

201

(v1.0) A new journalLine has been succesfully created

POST /companies({company_id})/journalLines
POST /companies({company_id})/journals({journal_id})/journalLines
operationId: JournalLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

journal_id path required string

(v1.0) id for journal

Request Body

application/json
schema JournalLineCreateD365ObjectRequest

Responses

201

(v1.0) A new journalLine has been succesfully created

POST /companies({company_id})/journals({journal_id})/journalLines

Paymentmethod 1 endpoints

POST /companies({company_id})/paymentMethods
operationId: PaymentMethod_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema PaymentMethodCreateD365ObjectRequest

Responses

201

(v1.0) A new paymentMethod has been succesfully created

POST /companies({company_id})/paymentMethods

Paymentterm 1 endpoints

POST /companies({company_id})/paymentTerms
operationId: PaymentTerm_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema PaymentTermCreateDynamicsObjectRequest

Responses

201

(v1.0) A new paymentTerm has been succesfully created

POST /companies({company_id})/paymentTerms

Project 1 endpoints

POST /companies({company_id})/projects
operationId: Project_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema ProjectCreateDynamicsObjectRequest

Responses

201

(v1.0) A new project has been succesfully created

POST /companies({company_id})/projects

Purchaseinvoice 2 endpoints

POST /companies({company_id})/purchaseInvoices
operationId: PurchaseInvoice_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema PurchaseInvoiceCreateDynamicsObjectRequest

Responses

201

(v1.0) A new purchaseInvoice has been succesfully created

POST /companies({company_id})/purchaseInvoices
POST /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/Microsoft.NAV.post
operationId: PurchaseInvoice_postAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

purchaseInvoice_id path required string

(v1.0) id for purchaseInvoice

Responses

204

(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central purchaseInvoices entity

POST /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/Microsoft.NAV.post

Purchaseinvoiceline 2 endpoints

POST /companies({company_id})/purchaseInvoiceLines
operationId: PurchaseInvoiceLine_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema PurchaseInvoiceLineCreateD365ObjectRequest

Responses

201

(v1.0) A new purchaseInvoiceLine has been succesfully created

POST /companies({company_id})/purchaseInvoiceLines
POST /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines
operationId: PurchaseInvoiceLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

purchaseInvoice_id path required string

(v1.0) id for purchaseInvoice

Request Body

application/json
schema PurchaseInvoiceLineCreateD365ObjectRequest

Responses

201

(v1.0) A new purchaseInvoiceLine has been succesfully created

POST /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines

Salescreditmemo 6 endpoints

POST /companies({company_id})/salesCreditMemos
operationId: SalesCreditMemo_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesCreditMemoCreateDynamicsObjectRequest

Responses

201

(v1.0) A new salesCreditMemo has been succesfully created

POST /companies({company_id})/salesCreditMemos
POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancel
operationId: SalesCreditMemo_cancelAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesCreditMemo_id path required string

(v1.0) id for salesCreditMemo

Responses

204

(v1.0) Succesfully performed a cancel action on the Dynamic 365 Business Central salesCreditMemos entity

POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancel
POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancelAndSend
operationId: SalesCreditMemo_cancelAndSend

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesCreditMemo_id path required string

(v1.0) id for salesCreditMemo

Responses

204

(v1.0) Succesfully performed a cancelAndSend action on the Dynamic 365 Business Central salesCreditMemos entity

POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancelAndSend
POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.post
operationId: SalesCreditMemo_postAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesCreditMemo_id path required string

(v1.0) id for salesCreditMemo

Responses

204

(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central salesCreditMemos entity

POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.post
POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.postAndSend
operationId: SalesCreditMemo_postAndSend

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesCreditMemo_id path required string

(v1.0) id for salesCreditMemo

Responses

204

(v1.0) Succesfully performed a postAndSend action on the Dynamic 365 Business Central salesCreditMemos entity

POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.postAndSend
POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.send
operationId: SalesCreditMemo_sendAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesCreditMemo_id path required string

(v1.0) id for salesCreditMemo

Responses

204

(v1.0) Succesfully performed a send action on the Dynamic 365 Business Central salesCreditMemos entity

POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.send

Salescreditmemoline 2 endpoints

POST /companies({company_id})/salesCreditMemoLines
operationId: SalesCreditMemoLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesCreditMemoLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesCreditMemoLine has been succesfully created

POST /companies({company_id})/salesCreditMemoLines
POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines
operationId: SalesCreditMemoLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesCreditMemo_id path required string

(v1.0) id for salesCreditMemo

Request Body

application/json
schema SalesCreditMemoLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesCreditMemoLine has been succesfully created

POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines

Salesinvoice 7 endpoints

POST /companies({company_id})/salesInvoices
operationId: SalesInvoice_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesInvoiceCreateDynamicsObjectRequest

Responses

201

(v1.0) A new salesInvoice has been succesfully created

POST /companies({company_id})/salesInvoices
POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancel
operationId: SalesInvoice_cancelAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesInvoice_id path required string

(v1.0) id for salesInvoice

Responses

204

(v1.0) Succesfully performed a cancel action on the Dynamic 365 Business Central salesInvoices entity

POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancel
POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancelAndSend
operationId: SalesInvoice_cancelAndSendAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesInvoice_id path required string

(v1.0) id for salesInvoice

Responses

204

(v1.0) Succesfully performed a cancelAndSend action on the Dynamic 365 Business Central salesInvoices entity

POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancelAndSend
POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.makeCorrectiveCreditMemo
operationId: SalesInvoice_performMakeCorrectiveCreditMemo

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesInvoice_id path required string

(v1.0) id for salesInvoice

Responses

204

(v1.0) Succesfully performed a makeCorrectiveCreditMemo action on the Dynamic 365 Business Central salesInvoices entity

POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.makeCorrectiveCreditMemo
POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.post
operationId: SalesInvoice_postAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesInvoice_id path required string

(v1.0) id for salesInvoice

Responses

204

(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central salesInvoices entity

POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.post
POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.postAndSend
operationId: SalesInvoice_postAndSendAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesInvoice_id path required string

(v1.0) id for salesInvoice

Responses

204

(v1.0) Succesfully performed a postAndSend action on the Dynamic 365 Business Central salesInvoices entity

POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.postAndSend
POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.send
operationId: SalesInvoice_sendAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesInvoice_id path required string

(v1.0) id for salesInvoice

Responses

204

(v1.0) Succesfully performed a send action on the Dynamic 365 Business Central salesInvoices entity

POST /companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.send

Salesinvoiceline 2 endpoints

POST /companies({company_id})/salesInvoiceLines
operationId: SalesInvoiceLine_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesInvoiceLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesInvoiceLine has been succesfully created

POST /companies({company_id})/salesInvoiceLines
POST /companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines
operationId: SalesInvoiceLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesInvoice_id path required string

(v1.0) id for salesInvoice

Request Body

application/json
schema SalesInvoiceLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesInvoiceLine has been succesfully created

POST /companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines

Salesorder 2 endpoints

POST /companies({company_id})/salesOrders
operationId: SalesOrder_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesOrderCreateDynamicsObjectRequest

Responses

201

(v1.0) A new salesOrder has been succesfully created

POST /companies({company_id})/salesOrders
POST /companies({company_id})/salesOrders({salesOrder_id})/Microsoft.NAV.shipAndInvoice
operationId: SalesOrder_shipAndInvoice

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesOrder_id path required string

(v1.0) id for salesOrder

Responses

204

(v1.0) Succesfully performed a shipAndInvoice action on the Dynamic 365 Business Central salesOrders entity

POST /companies({company_id})/salesOrders({salesOrder_id})/Microsoft.NAV.shipAndInvoice

Salesorderline 2 endpoints

POST /companies({company_id})/salesOrderLines
operationId: SalesOrderLine_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesOrderLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesOrderLine has been succesfully created

POST /companies({company_id})/salesOrderLines
POST /companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines
operationId: SalesOrderLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesOrder_id path required string

(v1.0) id for salesOrder

Request Body

application/json
schema SalesOrderLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesOrderLine has been succesfully created

POST /companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines

Salesquote 4 endpoints

POST /companies({company_id})/salesQuotes
operationId: SalesQuote_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesQuoteCreateD365ObjectRequest

Responses

201

(v1.0) A new salesQuote has been succesfully created

POST /companies({company_id})/salesQuotes
POST /companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeInvoice
operationId: SalesQuote_createInvoice

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesQuote_id path required string

(v1.0) id for salesQuote

Responses

204

(v1.0) Succesfully performed a makeInvoice action on the Dynamic 365 Business Central salesQuotes entity

POST /companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeInvoice
POST /companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeOrder
operationId: SalesQuote_createOrder

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesQuote_id path required string

(v1.0) id for salesQuote

Responses

204

(v1.0) Succesfully performed a makeOrder action on the Dynamic 365 Business Central salesQuotes entity

POST /companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeOrder
POST /companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.send
operationId: SalesQuote_sendAction

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesQuote_id path required string

(v1.0) id for salesQuote

Responses

204

(v1.0) Succesfully performed a send action on the Dynamic 365 Business Central salesQuotes entity

POST /companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.send

Salesquoteline 2 endpoints

POST /companies({company_id})/salesQuoteLines
operationId: SalesQuoteLine_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema SalesQuoteLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesQuoteLine has been succesfully created

POST /companies({company_id})/salesQuoteLines
POST /companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines
operationId: SalesQuoteLine_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

salesQuote_id path required string

(v1.0) id for salesQuote

Request Body

application/json
schema SalesQuoteLineCreateD365ObjectRequest

Responses

201

(v1.0) A new salesQuoteLine has been succesfully created

POST /companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines

Shipmentmethod 1 endpoints

POST /companies({company_id})/shipmentMethods
operationId: ShipmentMethod_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema ShipmentMethodCreateDynamicsObjectRequest

Responses

201

(v1.0) A new shipmentMethod has been succesfully created

POST /companies({company_id})/shipmentMethods

Taxarea 1 endpoints

POST /companies({company_id})/taxAreas
operationId: TaxArea_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema TaxAreaCreateD365ObjectRequest

Responses

201

(v1.0) A new taxArea has been succesfully created

POST /companies({company_id})/taxAreas

Taxgroup 1 endpoints

POST /companies({company_id})/taxGroups
operationId: TaxGroup_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema TaxGroupCreateDynamicsObjectRequest

Responses

201

(v1.0) A new taxGroup has been succesfully created

POST /companies({company_id})/taxGroups

Timeregistrationentry 2 endpoints

POST /companies({company_id})/employees({employee_id})/timeRegistrationEntries
operationId: TimeRegistrationEntry_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

employee_id path required string

(v1.0) id for employee

Request Body

application/json
schema TimeRegistrationEntryCreateDynamicsObjectRequest

Responses

201

(v1.0) A new timeRegistrationEntry has been succesfully created

POST /companies({company_id})/employees({employee_id})/timeRegistrationEntries
POST /companies({company_id})/timeRegistrationEntries
operationId: TimeRegistrationEntry_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema TimeRegistrationEntryCreateDynamicsObjectRequest

Responses

201

(v1.0) A new timeRegistrationEntry has been succesfully created

POST /companies({company_id})/timeRegistrationEntries

Unitofmeasure 1 endpoints

POST /companies({company_id})/unitsOfMeasure
operationId: UnitOfMeasure_createD365Object

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema UnitOfMeasureCreateD365ObjectRequest

Responses

201

(v1.0) A new unitOfMeasure has been succesfully created

POST /companies({company_id})/unitsOfMeasure

Vendor 1 endpoints

POST /companies({company_id})/vendors
operationId: Vendor_createDynamicsObject

Parameters

Name In Required Type Description
company_id path required string

(v1.0) id for company

Request Body

application/json
schema VendorCreateDynamicsObjectRequest

Responses

201

(v1.0) A new vendor has been succesfully created

POST /companies({company_id})/vendors

Schemas

object AccountGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account"
      }
    }
  }
}
object AgedAccountsPayableGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/agedAccountsPayable"
      }
    }
  }
}
object AgedAccountsReceivableGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/agedAccountsReceivable"
      }
    }
  }
}
object AttachmentsCreateD365ObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central attachments entity"
    },
    "content": {
      "type": "string",
      "format": "binary",
      "nullable": true,
      "description": "(v1.0) The content property for the Dynamics 365 Business Central attachments entity"
    },
    "byteSize": {
      "type": "integer",
      "format": "int32",
      "nullable": true,
      "description": "(v1.0) The byteSize property for the Dynamics 365 Business Central attachments entity"
    },
    "fileName": {
      "type": "string",
      "nullable": true,
      "maxLength": 250,
      "description": "(v1.0) The fileName property for the Dynamics 365 Business Central attachments entity"
    },
    "parentId": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The parentId property for the Dynamics 365 Business Central attachments entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central attachments entity"
    }
  }
}
object AttachmentsGetList200Response
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachments"
      }
    }
  }
}
object AttachmentsGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachments"
      }
    }
  }
}
object BalanceSheetGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balanceSheet"
      }
    }
  }
}
object BankAccountCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central bankAccount entity"
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The number property for the Dynamics 365 Business Central bankAccount entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central bankAccount entity"
    }
  }
}
object BankAccountGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bankAccount"
      }
    }
  }
}
object CashFlowStatementGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/cashFlowStatement"
      }
    }
  }
}
object CompanyGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/company"
      }
    }
  }
}
object CompanyInformationGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/companyInformation"
      }
    }
  }
}
object CompanyInformationUpdateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central companyInformation entity"
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 80,
      "description": "(v1.0) The email property for the Dynamics 365 Business Central companyInformation entity"
    },
    "address": {
      "$ref": "#/components/schemas/postaladdresstype",
      "nullable": true
    },
    "picture": {
      "type": "string",
      "format": "binary",
      "nullable": true,
      "description": "(v1.0) The picture property for the Dynamics 365 Business Central companyInformation entity"
    },
    "website": {
      "type": "string",
      "nullable": true,
      "maxLength": 80,
      "description": "(v1.0) The website property for the Dynamics 365 Business Central companyInformation entity"
    },
    "industry": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The industry property for the Dynamics 365 Business Central companyInformation entity"
    },
    "faxNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The faxNumber property for the Dynamics 365 Business Central companyInformation entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central companyInformation entity"
    },
    "phoneNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central companyInformation entity"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central companyInformation entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central companyInformation entity"
    },
    "taxRegistrationNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central companyInformation entity"
    },
    "currentFiscalYearStartDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The currentFiscalYearStartDate property for the Dynamics 365 Business Central companyInformation entity"
    }
  }
}
object CountryRegionCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central countryRegion entity"
    },
    "code": {
      "type": "string",
      "nullable": false,
      "maxLength": 10,
      "description": "(v1.0) The code property for the Dynamics 365 Business Central countryRegion entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 50,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity"
    },
    "addressFormat": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity"
    }
  }
}
object CountryRegionGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/countryRegion"
      }
    }
  }
}
object CurrencyCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central currency entity"
    },
    "code": {
      "type": "string",
      "nullable": false,
      "maxLength": 10,
      "description": "(v1.0) The code property for the Dynamics 365 Business Central currency entity"
    },
    "symbol": {
      "type": "string",
      "nullable": true,
      "maxLength": 10,
      "description": "(v1.0) The symbol property for the Dynamics 365 Business Central currency entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central currency entity"
    },
    "amountDecimalPlaces": {
      "type": "string",
      "nullable": true,
      "maxLength": 5,
      "description": "(v1.0) The amountDecimalPlaces property for the Dynamics 365 Business Central currency entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central currency entity"
    },
    "amountRoundingPrecision": {
      "type": "number",
      "format": "decimal",
      "nullable": true,
      "description": "(v1.0) The amountRoundingPrecision property for the Dynamics 365 Business Central currency entity"
    }
  }
}
object CurrencyGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/currency"
      }
    }
  }
}
object CustomerCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central customer entity"
    },
    "type": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The type property for the Dynamics 365 Business Central customer entity"
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 80,
      "description": "(v1.0) The email property for the Dynamics 365 Business Central customer entity"
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The number property for the Dynamics 365 Business Central customer entity"
    },
    "address": {
      "$ref": "#/components/schemas/postaladdresstype",
      "nullable": true
    },
    "blocked": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The blocked property for the Dynamics 365 Business Central customer entity"
    },
    "website": {
      "type": "string",
      "nullable": true,
      "maxLength": 80,
      "description": "(v1.0) The website property for the Dynamics 365 Business Central customer entity"
    },
    "taxAreaId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity"
    },
    "taxLiable": {
      "type": "boolean",
      "nullable": true,
      "description": "(v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity"
    },
    "currencyId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central customer entity"
    },
    "displayName": {
      "type": "string",
      "nullable": false,
      "maxLength": 100,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central customer entity"
    },
    "phoneNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity"
    },
    "paymentTermsId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity"
    },
    "paymentMethodId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity"
    },
    "shipmentMethodId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity"
    },
    "taxAreaDisplayName": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity"
    },
    "taxRegistrationNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity"
    }
  }
}
object CustomerFinancialDetailGetList200Response
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customerFinancialDetail"
      }
    }
  }
}
object CustomerFinancialDetailGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customerFinancialDetail"
      }
    }
  }
}
object CustomerGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customer"
      }
    }
  }
}
object CustomerPaymentCreateD365ObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central customerPayment entity"
    },
    "amount": {
      "type": "number",
      "format": "decimal",
      "nullable": true,
      "description": "(v1.0) The amount property for the Dynamics 365 Business Central customerPayment entity"
    },
    "comment": {
      "type": "string",
      "nullable": true,
      "maxLength": 250,
      "description": "(v1.0) The comment property for the Dynamics 365 Business Central customerPayment entity"
    },
    "contactId": {
      "type": "string",
      "nullable": true,
      "maxLength": 250,
      "description": "(v1.0) The contactId property for the Dynamics 365 Business Central customerPayment entity"
    },
    "customerId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The customerId property for the Dynamics 365 Business Central customerPayment entity"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dimensiontype",
        "nullable": true
      }
    },
    "lineNumber": {
      "type": "integer",
      "format": "int32",
      "nullable": true,
      "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central customerPayment entity"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The description property for the Dynamics 365 Business Central customerPayment entity"
    },
    "postingDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The postingDate property for the Dynamics 365 Business Central customerPayment entity"
    },
    "customerNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central customerPayment entity"
    },
    "documentNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The documentNumber property for the Dynamics 365 Business Central customerPayment entity"
    },
    "appliesToInvoiceId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The appliesToInvoiceId property for the Dynamics 365 Business Central customerPayment entity"
    },
    "journalDisplayName": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The journalDisplayName property for the Dynamics 365 Business Central customerPayment entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPayment entity"
    },
    "appliesToInvoiceNumber": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The appliesToInvoiceNumber property for the Dynamics 365 Business Central customerPayment entity"
    },
    "externalDocumentNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 35,
      "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central customerPayment entity"
    }
  }
}
object CustomerPaymentGetList200Response
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customerPayment"
      }
    }
  }
}
object CustomerPaymentGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customerPayment"
      }
    }
  }
}
object CustomerPaymentJournalCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central customerPaymentJournal entity"
    },
    "code": {
      "type": "string",
      "nullable": false,
      "maxLength": 10,
      "description": "(v1.0) The code property for the Dynamics 365 Business Central customerPaymentJournal entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central customerPaymentJournal entity"
    },
    "balancingAccountId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The balancingAccountId property for the Dynamics 365 Business Central customerPaymentJournal entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPaymentJournal entity"
    },
    "balancingAccountNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central customerPaymentJournal entity"
    }
  }
}
object CustomerPaymentJournalGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customerPaymentJournal"
      }
    }
  }
}
object CustomerSaleListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/customerSale"
      }
    }
  }
}
object DefaultDimensionsCreateDynamicsObjectRequest
{
  "properties": {
    "parentId": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The parentId property for the Dynamics 365 Business Central defaultDimensions entity"
    },
    "dimensionId": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The dimensionId property for the Dynamics 365 Business Central defaultDimensions entity"
    },
    "dimensionCode": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The dimensionCode property for the Dynamics 365 Business Central defaultDimensions entity"
    },
    "dimensionValueId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The dimensionValueId property for the Dynamics 365 Business Central defaultDimensions entity"
    },
    "postingValidation": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The postingValidation property for the Dynamics 365 Business Central defaultDimensions entity"
    },
    "dimensionValueCode": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The dimensionValueCode property for the Dynamics 365 Business Central defaultDimensions entity"
    }
  }
}
object DefaultDimensionsGetList200Response
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/defaultDimensions"
      }
    }
  }
}
object DefaultDimensionsGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/defaultDimensions"
      }
    }
  }
}
object DimensionGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dimension"
      }
    }
  }
}
object DimensionLineCreateD365ObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central dimensionLine entity"
    },
    "code": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The code property for the Dynamics 365 Business Central dimensionLine entity"
    },
    "valueId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The valueId property for the Dynamics 365 Business Central dimensionLine entity"
    },
    "parentId": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The parentId property for the Dynamics 365 Business Central dimensionLine entity"
    },
    "valueCode": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The valueCode property for the Dynamics 365 Business Central dimensionLine entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central dimensionLine entity"
    },
    "valueDisplayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 50,
      "description": "(v1.0) The valueDisplayName property for the Dynamics 365 Business Central dimensionLine entity"
    }
  }
}
object DimensionLineGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dimensionLine"
      }
    }
  }
}
object DimensionValueGetList200Response
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dimensionValue"
      }
    }
  }
}
object DimensionValueGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dimensionValue"
      }
    }
  }
}
object EmployeeCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central employee entity"
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 80,
      "description": "(v1.0) The email property for the Dynamics 365 Business Central employee entity"
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The number property for the Dynamics 365 Business Central employee entity"
    },
    "status": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The status property for the Dynamics 365 Business Central employee entity"
    },
    "address": {
      "$ref": "#/components/schemas/postaladdresstype",
      "nullable": true
    },
    "surname": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The surname property for the Dynamics 365 Business Central employee entity"
    },
    "jobTitle": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The jobTitle property for the Dynamics 365 Business Central employee entity"
    },
    "birthDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The birthDate property for the Dynamics 365 Business Central employee entity"
    },
    "givenName": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The givenName property for the Dynamics 365 Business Central employee entity"
    },
    "middleName": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The middleName property for the Dynamics 365 Business Central employee entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central employee entity"
    },
    "mobilePhone": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The mobilePhone property for the Dynamics 365 Business Central employee entity"
    },
    "phoneNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 30,
      "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central employee entity"
    },
    "personalEmail": {
      "type": "string",
      "nullable": true,
      "maxLength": 80,
      "description": "(v1.0) The personalEmail property for the Dynamics 365 Business Central employee entity"
    },
    "employmentDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The employmentDate property for the Dynamics 365 Business Central employee entity"
    },
    "terminationDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The terminationDate property for the Dynamics 365 Business Central employee entity"
    },
    "statisticsGroupCode": {
      "type": "string",
      "nullable": true,
      "maxLength": 10,
      "description": "(v1.0) The statisticsGroupCode property for the Dynamics 365 Business Central employee entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central employee entity"
    }
  }
}
object EmployeeGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/employee"
      }
    }
  }
}
object GeneralLedgerEntryAttachmentsCreateD365ObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity"
    },
    "content": {
      "type": "string",
      "format": "binary",
      "nullable": true,
      "description": "(v1.0) The content property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity"
    },
    "byteSize": {
      "type": "integer",
      "format": "int32",
      "nullable": true,
      "description": "(v1.0) The byteSize property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity"
    },
    "fileName": {
      "type": "string",
      "nullable": true,
      "maxLength": 250,
      "description": "(v1.0) The fileName property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity"
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The createdDateTime property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity"
    },
    "generalLedgerEntryNumber": {
      "type": "integer",
      "format": "int32",
      "nullable": false,
      "description": "(v1.0) The generalLedgerEntryNumber property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity"
    }
  }
}
object GeneralLedgerEntryAttachmentsGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/generalLedgerEntryAttachments"
      }
    }
  }
}
object GeneralLedgerEntryGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/generalLedgerEntry"
      }
    }
  }
}
object IncomeStatementGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/incomeStatement"
      }
    }
  }
}
object ItemCategoryCreateD365ObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central itemCategory entity"
    },
    "code": {
      "type": "string",
      "nullable": false,
      "maxLength": 20,
      "description": "(v1.0) The code property for the Dynamics 365 Business Central itemCategory entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central itemCategory entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central itemCategory entity"
    }
  }
}
object ItemCategoryGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/itemCategory"
      }
    }
  }
}
object ItemCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central item entity"
    },
    "gtin": {
      "type": "string",
      "nullable": true,
      "maxLength": 14,
      "description": "(v1.0) The gtin property for the Dynamics 365 Business Central item entity"
    },
    "type": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The type property for the Dynamics 365 Business Central item entity"
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The number property for the Dynamics 365 Business Central item entity"
    },
    "blocked": {
      "type": "boolean",
      "nullable": true,
      "description": "(v1.0) The blocked property for the Dynamics 365 Business Central item entity"
    },
    "unitCost": {
      "type": "number",
      "format": "decimal",
      "nullable": true,
      "description": "(v1.0) The unitCost property for the Dynamics 365 Business Central item entity"
    },
    "inventory": {
      "type": "number",
      "format": "decimal",
      "nullable": true,
      "description": "(v1.0) The inventory property for the Dynamics 365 Business Central item entity"
    },
    "unitPrice": {
      "type": "number",
      "format": "decimal",
      "nullable": true,
      "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central item entity"
    },
    "taxGroupId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The taxGroupId property for the Dynamics 365 Business Central item entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central item entity"
    },
    "taxGroupCode": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The taxGroupCode property for the Dynamics 365 Business Central item entity"
    },
    "itemCategoryId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The itemCategoryId property for the Dynamics 365 Business Central item entity"
    },
    "itemCategoryCode": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The itemCategoryCode property for the Dynamics 365 Business Central item entity"
    },
    "priceIncludesTax": {
      "type": "boolean",
      "nullable": true,
      "description": "(v1.0) The priceIncludesTax property for the Dynamics 365 Business Central item entity"
    },
    "baseUnitOfMeasure": {
      "$ref": "#/components/schemas/unitofmeasuretype",
      "nullable": true
    },
    "baseUnitOfMeasureId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The baseUnitOfMeasureId property for the Dynamics 365 Business Central item entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central item entity"
    }
  }
}
object ItemListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/item"
      }
    }
  }
}
object JournalCreateDynamicsObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central journal entity"
    },
    "code": {
      "type": "string",
      "nullable": false,
      "maxLength": 10,
      "description": "(v1.0) The code property for the Dynamics 365 Business Central journal entity"
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The displayName property for the Dynamics 365 Business Central journal entity"
    },
    "balancingAccountId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The balancingAccountId property for the Dynamics 365 Business Central journal entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journal entity"
    },
    "balancingAccountNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central journal entity"
    }
  }
}
object JournalGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/journal"
      }
    }
  }
}
object JournalLineCreateD365ObjectRequest
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "nullable": false,
      "description": "(v1.0) The id property for the Dynamics 365 Business Central journalLine entity"
    },
    "amount": {
      "type": "number",
      "format": "decimal",
      "nullable": true,
      "description": "(v1.0) The amount property for the Dynamics 365 Business Central journalLine entity"
    },
    "comment": {
      "type": "string",
      "nullable": true,
      "maxLength": 250,
      "description": "(v1.0) The comment property for the Dynamics 365 Business Central journalLine entity"
    },
    "accountId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "(v1.0) The accountId property for the Dynamics 365 Business Central journalLine entity"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dimensiontype",
        "nullable": true
      }
    },
    "lineNumber": {
      "type": "integer",
      "format": "int32",
      "nullable": true,
      "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central journalLine entity"
    },
    "accountType": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The accountType property for the Dynamics 365 Business Central journalLine entity"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "(v1.0) The description property for the Dynamics 365 Business Central journalLine entity"
    },
    "postingDate": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The postingDate property for the Dynamics 365 Business Central journalLine entity"
    },
    "accountNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The accountNumber property for the Dynamics 365 Business Central journalLine entity"
    },
    "documentNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "(v1.0) The documentNumber property for the Dynamics 365 Business Central journalLine entity"
    },
    "journalDisplayName": {
      "type": "string",
      "nullable": true,
      "description": "(v1.0) The journalDisplayName property for the Dynamics 365 Business Central journalLine entity"
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journalLine entity"
    },
    "externalDocumentNumber": {
      "type": "string",
      "nullable": true,
      "maxLength": 35,
      "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central journalLine entity"
    }
  }
}
object JournalLineGetList200Response
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/journalLine"
      }
    }
  }
}
object JournalLineGetListResponse
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/journalLine"
      }
    }
  }
}

Versions

Version Endpoints Schemas Ingested Status
1.0.0 324 162 2026-05-11 current
1.0.0 324 162 2026-04-16