(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

GET POST PUT PATCH DELETE

Attachments 3 endpoints

DELETE /companies({company_id})/attachments({attachments_parentId},{attachments_id}) Deletes an object of type attachments in Dynamics 365 Business Central

operationId: Attachments_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
attachments_parentId	path	required	string	(v1.0) parentId for attachments
attachments_id	path	required	string	(v1.0) id for attachments

Responses

204

(v1.0) Succesfully deleted the specified attachments

DELETE /companies({company_id})/attachments({attachments_parentId},{attachments_id})

DELETE /companies({company_id})/journalLines({journalLine_id})/attachments({attachments_parentId},{attachments_id}) Deletes an object of type attachments in Dynamics 365 Business Central

operationId: Attachments_deleteObject

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
attachments_parentId	path	required	string	(v1.0) parentId for attachments
attachments_id	path	required	string	(v1.0) id for attachments

Responses

204

(v1.0) Succesfully deleted the specified attachments

DELETE /companies({company_id})/journalLines({journalLine_id})/attachments({attachments_parentId},{attachments_id})

DELETE

/companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments({attachments_parentId},{attachments_id})

Deletes an object of type attachments in Dynamics 365 Business Central

operationId: Attachments_deleteObject

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
attachments_parentId	path	required	string	(v1.0) parentId for attachments
attachments_id	path	required	string	(v1.0) id for attachments

Responses

204

(v1.0) Succesfully deleted the specified attachments

DELETE /companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments({attachments_parentId},{attachments_id})

Bankaccount 1 endpoints

DELETE /companies({company_id})/bankAccounts({bankAccount_id}) Deletes an object of type bankAccount in Dynamics 365 Business Central

operationId: BankAccount_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
bankAccount_id	path	required	string	(v1.0) id for bankAccount

Responses

204

(v1.0) Succesfully deleted the specified bankAccount

DELETE /companies({company_id})/bankAccounts({bankAccount_id})

Countryregion 1 endpoints

DELETE /companies({company_id})/countriesRegions({countryRegion_id}) Deletes an object of type countryRegion in Dynamics 365 Business Central

operationId: CountryRegion_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
countryRegion_id	path	required	string	(v1.0) id for countryRegion

Responses

204

(v1.0) Succesfully deleted the specified countryRegion

DELETE /companies({company_id})/countriesRegions({countryRegion_id})

Currency 1 endpoints

DELETE /companies({company_id})/currencies({currency_id}) Deletes an object of type currency in Dynamics 365 Business Central

operationId: Currency_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
currency_id	path	required	string	(v1.0) id for currency

Responses

204

(v1.0) Succesfully deleted the specified currency

DELETE /companies({company_id})/currencies({currency_id})

Customer 1 endpoints

DELETE /companies({company_id})/customers({customer_id}) Deletes an object of type customer in Dynamics 365 Business Central

operationId: Customer_deleteD365Object

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

Responses

204

(v1.0) Succesfully deleted the specified customer

DELETE /companies({company_id})/customers({customer_id})

Customerpayment 2 endpoints

DELETE /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments({customerPayment_id}) Deletes an object of type customerPayment in Dynamics 365 Business Central

operationId: CustomerPayment_deleteObject

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
customerPayment_id	path	required	string	(v1.0) id for customerPayment

Responses

204

(v1.0) Succesfully deleted the specified customerPayment

DELETE /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments({customerPayment_id})

DELETE /companies({company_id})/customerPayments({customerPayment_id}) Deletes an object of type customerPayment in Dynamics 365 Business Central

operationId: CustomerPayment_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
customerPayment_id	path	required	string	(v1.0) id for customerPayment

Responses

204

(v1.0) Succesfully deleted the specified customerPayment

DELETE /companies({company_id})/customerPayments({customerPayment_id})

Customerpaymentjournal 1 endpoints

DELETE /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id}) Deletes an object of type customerPaymentJournal in Dynamics 365 Business Central

operationId: CustomerPaymentJournal_deleteObject

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

Responses

204

(v1.0) Succesfully deleted the specified customerPaymentJournal

DELETE /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})

Defaultdimensions 5 endpoints

DELETE

/companies({company_id})/customers({customer_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

Deletes an object of type defaultDimensions in Dynamics 365 Business Central

operationId: DefaultDimensions_deleteObject

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
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions

Responses

204

(v1.0) Succesfully deleted the specified defaultDimensions

DELETE /companies({company_id})/customers({customer_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

DELETE /companies({company_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId}) Deletes an object of type defaultDimensions in Dynamics 365 Business Central

operationId: DefaultDimensions_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions

Responses

204

(v1.0) Succesfully deleted the specified defaultDimensions

DELETE /companies({company_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

DELETE

/companies({company_id})/employees({employee_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

Deletes an object of type defaultDimensions in Dynamics 365 Business Central

operationId: DefaultDimensions_deleteD365Object

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
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions

Responses

204

(v1.0) Succesfully deleted the specified defaultDimensions

DELETE /companies({company_id})/employees({employee_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

DELETE

/companies({company_id})/items({item_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

Deletes an object of type defaultDimensions in Dynamics 365 Business Central

operationId: DefaultDimensions_deleteObject

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
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions

Responses

204

(v1.0) Succesfully deleted the specified defaultDimensions

DELETE /companies({company_id})/items({item_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

DELETE

/companies({company_id})/vendors({vendor_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

Deletes an object of type defaultDimensions in Dynamics 365 Business Central

operationId: DefaultDimensions_deleteObject

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
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions

Responses

204

(v1.0) Succesfully deleted the specified defaultDimensions

DELETE /companies({company_id})/vendors({vendor_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})

Dimensionline 1 endpoints

DELETE /companies({company_id})/dimensionLines({dimensionLine_parentId},{dimensionLine_id}) Deletes an object of type dimensionLine in Dynamics 365 Business Central

operationId: DimensionLine_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
dimensionLine_parentId	path	required	string	(v1.0) parentId for dimensionLine
dimensionLine_id	path	required	string	(v1.0) id for dimensionLine

Responses

204

(v1.0) Succesfully deleted the specified dimensionLine

DELETE /companies({company_id})/dimensionLines({dimensionLine_parentId},{dimensionLine_id})

Employee 1 endpoints

DELETE /companies({company_id})/employees({employee_id}) Deletes an object of type employee in Dynamics 365 Business Central

operationId: Employee_deleteD365Object

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

Responses

204

(v1.0) Succesfully deleted the specified employee

DELETE /companies({company_id})/employees({employee_id})

Generalledgerentryattachments 1 endpoints

DELETE

/companies({company_id})/generalLedgerEntryAttachments({generalLedgerEntryAttachments_generalLedgerEntryNumber},{generalLedgerEntryAttachments_id})

Deletes an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central

operationId: GeneralLedgerEntryAttachments_deleteD365Object

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
generalLedgerEntryAttachments_generalLedgerEntryNumber	path	required	integer	(v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments
generalLedgerEntryAttachments_id	path	required	string	(v1.0) id for generalLedgerEntryAttachments

Responses

204

(v1.0) Succesfully deleted the specified generalLedgerEntryAttachments

DELETE /companies({company_id})/generalLedgerEntryAttachments({generalLedgerEntryAttachments_generalLedgerEntryNumber},{generalLedgerEntryAttachments_id})

Item 1 endpoints

DELETE /companies({company_id})/items({item_id}) Deletes an object of type item in Dynamics 365 Business Central

operationId: Item_deleteD365Object

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

Responses

204

(v1.0) Succesfully deleted the specified item

DELETE /companies({company_id})/items({item_id})

Itemcategory 1 endpoints

DELETE /companies({company_id})/itemCategories({itemCategory_id}) Deletes an object of type itemCategory in Dynamics 365 Business Central

operationId: ItemCategory_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
itemCategory_id	path	required	string	(v1.0) id for itemCategory

Responses

204

(v1.0) Succesfully deleted the specified itemCategory

DELETE /companies({company_id})/itemCategories({itemCategory_id})

Journal 1 endpoints

DELETE /companies({company_id})/journals({journal_id}) Deletes an object of type journal in Dynamics 365 Business Central

operationId: Journal_deleteDynamicsObject

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 deleted the specified journal

DELETE /companies({company_id})/journals({journal_id})

Journalline 2 endpoints

DELETE /companies({company_id})/journalLines({journalLine_id}) Deletes an object of type journalLine in Dynamics 365 Business Central

operationId: JournalLine_deleteDynamicsObject

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

Responses

204

(v1.0) Succesfully deleted the specified journalLine

DELETE /companies({company_id})/journalLines({journalLine_id})

DELETE /companies({company_id})/journals({journal_id})/journalLines({journalLine_id}) Deletes an object of type journalLine in Dynamics 365 Business Central

operationId: JournalLine_deleteObject

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

Responses

204

(v1.0) Succesfully deleted the specified journalLine

DELETE /companies({company_id})/journals({journal_id})/journalLines({journalLine_id})

Paymentmethod 1 endpoints

DELETE /companies({company_id})/paymentMethods({paymentMethod_id}) Deletes an object of type paymentMethod in Dynamics 365 Business Central

operationId: PaymentMethod_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
paymentMethod_id	path	required	string	(v1.0) id for paymentMethod

Responses

204

(v1.0) Succesfully deleted the specified paymentMethod

DELETE /companies({company_id})/paymentMethods({paymentMethod_id})

Paymentterm 1 endpoints

DELETE /companies({company_id})/paymentTerms({paymentTerm_id}) Deletes an object of type paymentTerm in Dynamics 365 Business Central

operationId: PaymentTerm_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
paymentTerm_id	path	required	string	(v1.0) id for paymentTerm

Responses

204

(v1.0) Succesfully deleted the specified paymentTerm

DELETE /companies({company_id})/paymentTerms({paymentTerm_id})

Picture 5 endpoints

DELETE /companies({company_id})/customers({customer_id})/picture({picture_id}) Deletes an object of type picture in Dynamics 365 Business Central

operationId: Picture_deleteObjectById

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
picture_id	path	required	string	(v1.0) id for picture

Responses

204

(v1.0) Succesfully deleted the specified picture

DELETE /companies({company_id})/customers({customer_id})/picture({picture_id})

DELETE /companies({company_id})/employees({employee_id})/picture({picture_id}) Deletes an object of type picture in Dynamics 365 Business Central

operationId: Picture_deleteObjectById

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
picture_id	path	required	string	(v1.0) id for picture

Responses

204

(v1.0) Succesfully deleted the specified picture

DELETE /companies({company_id})/employees({employee_id})/picture({picture_id})

DELETE /companies({company_id})/items({item_id})/picture({picture_id}) Deletes an object of type picture in Dynamics 365 Business Central

operationId: Picture_deleteObjectById

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
picture_id	path	required	string	(v1.0) id for picture

Responses

204

(v1.0) Succesfully deleted the specified picture

DELETE /companies({company_id})/items({item_id})/picture({picture_id})

DELETE /companies({company_id})/picture({picture_id}) Deletes an object of type picture in Dynamics 365 Business Central

operationId: Picture_deleteD365Object

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
picture_id	path	required	string	(v1.0) id for picture

Responses

204

(v1.0) Succesfully deleted the specified picture

DELETE /companies({company_id})/picture({picture_id})

DELETE /companies({company_id})/vendors({vendor_id})/picture({picture_id}) Deletes an object of type picture in Dynamics 365 Business Central

operationId: Picture_deleteObjectById

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
picture_id	path	required	string	(v1.0) id for picture

Responses

204

(v1.0) Succesfully deleted the specified picture

DELETE /companies({company_id})/vendors({vendor_id})/picture({picture_id})

Project 1 endpoints

DELETE /companies({company_id})/projects({project_id}) Deletes an object of type project in Dynamics 365 Business Central

operationId: Project_deleteD365Object

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
project_id	path	required	string	(v1.0) id for project

Responses

204

(v1.0) Succesfully deleted the specified project

DELETE /companies({company_id})/projects({project_id})

Purchaseinvoice 1 endpoints

DELETE /companies({company_id})/purchaseInvoices({purchaseInvoice_id}) Deletes an object of type purchaseInvoice in Dynamics 365 Business Central

operationId: PurchaseInvoice_deleteDynamicsObject

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 deleted the specified purchaseInvoice

DELETE /companies({company_id})/purchaseInvoices({purchaseInvoice_id})

Purchaseinvoiceline 2 endpoints

DELETE /companies({company_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}') Deletes an object of type purchaseInvoiceLine in Dynamics 365 Business Central

operationId: PurchaseInvoiceLine_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
purchaseInvoiceLine_id	path	required	string	(v1.0) id for purchaseInvoiceLine

Responses

204

(v1.0) Succesfully deleted the specified purchaseInvoiceLine

DELETE /companies({company_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}')

DELETE /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}') Deletes an object of type purchaseInvoiceLine in Dynamics 365 Business Central

operationId: PurchaseInvoiceLine_delete

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
purchaseInvoiceLine_id	path	required	string	(v1.0) id for purchaseInvoiceLine

Responses

204

(v1.0) Succesfully deleted the specified purchaseInvoiceLine

DELETE /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}')

Salescreditmemo 1 endpoints

DELETE /companies({company_id})/salesCreditMemos({salesCreditMemo_id}) Deletes an object of type salesCreditMemo in Dynamics 365 Business Central

operationId: SalesCreditMemo_deleteObject

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 deleted the specified salesCreditMemo

DELETE /companies({company_id})/salesCreditMemos({salesCreditMemo_id})

Salescreditmemoline 2 endpoints

DELETE /companies({company_id})/salesCreditMemoLines('{salesCreditMemoLine_id}') Deletes an object of type salesCreditMemoLine in Dynamics 365 Business Central

operationId: SalesCreditMemoLine_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesCreditMemoLine_id	path	required	string	(v1.0) id for salesCreditMemoLine

Responses

204

(v1.0) Succesfully deleted the specified salesCreditMemoLine

DELETE /companies({company_id})/salesCreditMemoLines('{salesCreditMemoLine_id}')

DELETE /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines('{salesCreditMemoLine_id}') Deletes an object of type salesCreditMemoLine in Dynamics 365 Business Central

operationId: SalesCreditMemoLine_delete

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
salesCreditMemoLine_id	path	required	string	(v1.0) id for salesCreditMemoLine

Responses

204

(v1.0) Succesfully deleted the specified salesCreditMemoLine

DELETE /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines('{salesCreditMemoLine_id}')

Salesinvoice 1 endpoints

DELETE /companies({company_id})/salesInvoices({salesInvoice_id}) Deletes an object of type salesInvoice in Dynamics 365 Business Central

operationId: SalesInvoice_deleteObject

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 deleted the specified salesInvoice

DELETE /companies({company_id})/salesInvoices({salesInvoice_id})

Salesinvoiceline 2 endpoints

DELETE /companies({company_id})/salesInvoiceLines('{salesInvoiceLine_id}') Deletes an object of type salesInvoiceLine in Dynamics 365 Business Central

operationId: SalesInvoiceLine_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesInvoiceLine_id	path	required	string	(v1.0) id for salesInvoiceLine

Responses

204

(v1.0) Succesfully deleted the specified salesInvoiceLine

DELETE /companies({company_id})/salesInvoiceLines('{salesInvoiceLine_id}')

DELETE /companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines('{salesInvoiceLine_id}') Deletes an object of type salesInvoiceLine in Dynamics 365 Business Central

operationId: SalesInvoiceLine_delete

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
salesInvoiceLine_id	path	required	string	(v1.0) id for salesInvoiceLine

Responses

204

(v1.0) Succesfully deleted the specified salesInvoiceLine

DELETE /companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines('{salesInvoiceLine_id}')

Salesorder 1 endpoints

DELETE /companies({company_id})/salesOrders({salesOrder_id}) Deletes an object of type salesOrder in Dynamics 365 Business Central

operationId: SalesOrder_deleteDynamicsObject

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 deleted the specified salesOrder

DELETE /companies({company_id})/salesOrders({salesOrder_id})

Salesorderline 2 endpoints

DELETE /companies({company_id})/salesOrderLines('{salesOrderLine_id}') Deletes an object of type salesOrderLine in Dynamics 365 Business Central

operationId: SalesOrderLine_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesOrderLine_id	path	required	string	(v1.0) id for salesOrderLine

Responses

204

(v1.0) Succesfully deleted the specified salesOrderLine

DELETE /companies({company_id})/salesOrderLines('{salesOrderLine_id}')

DELETE /companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines('{salesOrderLine_id}') Deletes an object of type salesOrderLine in Dynamics 365 Business Central

operationId: SalesOrderLine_deleteObject

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
salesOrderLine_id	path	required	string	(v1.0) id for salesOrderLine

Responses

204

(v1.0) Succesfully deleted the specified salesOrderLine

DELETE /companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines('{salesOrderLine_id}')

Salesquote 1 endpoints

DELETE /companies({company_id})/salesQuotes({salesQuote_id}) Deletes an object of type salesQuote in Dynamics 365 Business Central

operationId: SalesQuote_deleteDynamicsObject

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 deleted the specified salesQuote

DELETE /companies({company_id})/salesQuotes({salesQuote_id})

Salesquoteline 2 endpoints

DELETE /companies({company_id})/salesQuoteLines('{salesQuoteLine_id}') Deletes an object of type salesQuoteLine in Dynamics 365 Business Central

operationId: SalesQuoteLine_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesQuoteLine_id	path	required	string	(v1.0) id for salesQuoteLine

Responses

204

(v1.0) Succesfully deleted the specified salesQuoteLine

DELETE /companies({company_id})/salesQuoteLines('{salesQuoteLine_id}')

DELETE /companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines('{salesQuoteLine_id}') Deletes an object of type salesQuoteLine in Dynamics 365 Business Central

operationId: SalesQuoteLine_deleteObject

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
salesQuoteLine_id	path	required	string	(v1.0) id for salesQuoteLine

Responses

204

(v1.0) Succesfully deleted the specified salesQuoteLine

DELETE /companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines('{salesQuoteLine_id}')

Shipmentmethod 1 endpoints

DELETE /companies({company_id})/shipmentMethods({shipmentMethod_id}) Deletes an object of type shipmentMethod in Dynamics 365 Business Central

operationId: ShipmentMethod_deleteById

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
shipmentMethod_id	path	required	string	(v1.0) id for shipmentMethod

Responses

204

(v1.0) Succesfully deleted the specified shipmentMethod

DELETE /companies({company_id})/shipmentMethods({shipmentMethod_id})

Taxarea 1 endpoints

DELETE /companies({company_id})/taxAreas({taxArea_id}) Deletes an object of type taxArea in Dynamics 365 Business Central

operationId: TaxArea_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
taxArea_id	path	required	string	(v1.0) id for taxArea

Responses

204

(v1.0) Succesfully deleted the specified taxArea

DELETE /companies({company_id})/taxAreas({taxArea_id})

Taxgroup 1 endpoints

DELETE /companies({company_id})/taxGroups({taxGroup_id}) Deletes an object of type taxGroup in Dynamics 365 Business Central

operationId: TaxGroup_deleteDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
taxGroup_id	path	required	string	(v1.0) id for taxGroup

Responses

204

(v1.0) Succesfully deleted the specified taxGroup

DELETE /companies({company_id})/taxGroups({taxGroup_id})

Timeregistrationentry 2 endpoints

DELETE /companies({company_id})/employees({employee_id})/timeRegistrationEntries({timeRegistrationEntry_id}) Deletes an object of type timeRegistrationEntry in Dynamics 365 Business Central

operationId: TimeRegistrationEntry_deleteD365Object

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
timeRegistrationEntry_id	path	required	string	(v1.0) id for timeRegistrationEntry

Responses

204

(v1.0) Succesfully deleted the specified timeRegistrationEntry

DELETE /companies({company_id})/employees({employee_id})/timeRegistrationEntries({timeRegistrationEntry_id})

DELETE /companies({company_id})/timeRegistrationEntries({timeRegistrationEntry_id}) Deletes an object of type timeRegistrationEntry in Dynamics 365 Business Central

operationId: TimeRegistrationEntry_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
timeRegistrationEntry_id	path	required	string	(v1.0) id for timeRegistrationEntry

Responses

204

(v1.0) Succesfully deleted the specified timeRegistrationEntry

DELETE /companies({company_id})/timeRegistrationEntries({timeRegistrationEntry_id})

Unitofmeasure 1 endpoints

DELETE /companies({company_id})/unitsOfMeasure({unitOfMeasure_id}) Deletes an object of type unitOfMeasure in Dynamics 365 Business Central

operationId: UnitOfMeasure_deleteObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
unitOfMeasure_id	path	required	string	(v1.0) id for unitOfMeasure

Responses

204

(v1.0) Succesfully deleted the specified unitOfMeasure

DELETE /companies({company_id})/unitsOfMeasure({unitOfMeasure_id})

Vendor 1 endpoints

DELETE /companies({company_id})/vendors({vendor_id}) Deletes an object of type vendor in Dynamics 365 Business Central

operationId: Vendor_deleteD365Object

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

Responses

204

(v1.0) Succesfully deleted the specified vendor

DELETE /companies({company_id})/vendors({vendor_id})

Load more endpoints

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"
      }
    }
  }
}

Load more schemas

Versions

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