Business management and ERP solution
learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api ↗Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v1.0
https://api.businesscentral.dynamics.com/v2.0/production/api/v1.0
/companies({company_id})/attachments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
AttachmentsCreateD365ObjectRequest
(v1.0) A new attachments has been succesfully created
POST /companies({company_id})/attachments
/companies({company_id})/journalLines({journalLine_id})/attachments
| 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 |
application/json
AttachmentsCreateD365ObjectRequest
(v1.0) A new attachments has been succesfully created
POST /companies({company_id})/journalLines({journalLine_id})/attachments
/companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments
| 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 |
application/json
AttachmentsCreateD365ObjectRequest
(v1.0) A new attachments has been succesfully created
POST /companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments
/companies({company_id})/bankAccounts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
BankAccountCreateDynamicsObjectRequest
(v1.0) A new bankAccount has been succesfully created
POST /companies({company_id})/bankAccounts
/companies({company_id})/countriesRegions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
CountryRegionCreateDynamicsObjectRequest
(v1.0) A new countryRegion has been succesfully created
POST /companies({company_id})/countriesRegions
/companies({company_id})/currencies
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
CurrencyCreateDynamicsObjectRequest
(v1.0) A new currency has been succesfully created
POST /companies({company_id})/currencies
/companies({company_id})/customers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
CustomerCreateDynamicsObjectRequest
(v1.0) A new customer has been succesfully created
POST /companies({company_id})/customers
/companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments
| 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 |
application/json
CustomerPaymentCreateD365ObjectRequest
(v1.0) A new customerPayment has been succesfully created
POST /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments
/companies({company_id})/customerPayments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
CustomerPaymentCreateD365ObjectRequest
(v1.0) A new customerPayment has been succesfully created
POST /companies({company_id})/customerPayments
/companies({company_id})/customerPaymentJournals
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
CustomerPaymentJournalCreateDynamicsObjectRequest
(v1.0) A new customerPaymentJournal has been succesfully created
POST /companies({company_id})/customerPaymentJournals
/companies({company_id})/customers({customer_id})/defaultDimensions
| 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 |
application/json
DefaultDimensionsCreateDynamicsObjectRequest
(v1.0) A new defaultDimensions has been succesfully created
POST /companies({company_id})/customers({customer_id})/defaultDimensions
/companies({company_id})/defaultDimensions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
DefaultDimensionsCreateDynamicsObjectRequest
(v1.0) A new defaultDimensions has been succesfully created
POST /companies({company_id})/defaultDimensions
/companies({company_id})/employees({employee_id})/defaultDimensions
| 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 |
application/json
DefaultDimensionsCreateDynamicsObjectRequest
(v1.0) A new defaultDimensions has been succesfully created
POST /companies({company_id})/employees({employee_id})/defaultDimensions
/companies({company_id})/items({item_id})/defaultDimensions
| 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 |
application/json
DefaultDimensionsCreateDynamicsObjectRequest
(v1.0) A new defaultDimensions has been succesfully created
POST /companies({company_id})/items({item_id})/defaultDimensions
/companies({company_id})/vendors({vendor_id})/defaultDimensions
| 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 |
application/json
DefaultDimensionsCreateDynamicsObjectRequest
(v1.0) A new defaultDimensions has been succesfully created
POST /companies({company_id})/vendors({vendor_id})/defaultDimensions
/companies({company_id})/dimensionLines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
DimensionLineCreateD365ObjectRequest
(v1.0) A new dimensionLine has been succesfully created
POST /companies({company_id})/dimensionLines
/companies({company_id})/employees
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
EmployeeCreateDynamicsObjectRequest
(v1.0) A new employee has been succesfully created
POST /companies({company_id})/employees
/companies({company_id})/generalLedgerEntryAttachments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
GeneralLedgerEntryAttachmentsCreateD365ObjectRequest
(v1.0) A new generalLedgerEntryAttachments has been succesfully created
POST /companies({company_id})/generalLedgerEntryAttachments
/companies({company_id})/items
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
ItemCreateDynamicsObjectRequest
(v1.0) A new item has been succesfully created
POST /companies({company_id})/items
/companies({company_id})/itemCategories
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
ItemCategoryCreateD365ObjectRequest
(v1.0) A new itemCategory has been succesfully created
POST /companies({company_id})/itemCategories
/companies({company_id})/journals
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
JournalCreateDynamicsObjectRequest
(v1.0) A new journal has been succesfully created
POST /companies({company_id})/journals
/companies({company_id})/journals({journal_id})/Microsoft.NAV.post
| 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 |
(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
/companies({company_id})/journalLines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
JournalLineCreateD365ObjectRequest
(v1.0) A new journalLine has been succesfully created
POST /companies({company_id})/journalLines
/companies({company_id})/journals({journal_id})/journalLines
| 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 |
application/json
JournalLineCreateD365ObjectRequest
(v1.0) A new journalLine has been succesfully created
POST /companies({company_id})/journals({journal_id})/journalLines
/companies({company_id})/paymentMethods
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
PaymentMethodCreateD365ObjectRequest
(v1.0) A new paymentMethod has been succesfully created
POST /companies({company_id})/paymentMethods
/companies({company_id})/paymentTerms
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
PaymentTermCreateDynamicsObjectRequest
(v1.0) A new paymentTerm has been succesfully created
POST /companies({company_id})/paymentTerms
/companies({company_id})/projects
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
ProjectCreateDynamicsObjectRequest
(v1.0) A new project has been succesfully created
POST /companies({company_id})/projects
/companies({company_id})/purchaseInvoices
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
PurchaseInvoiceCreateDynamicsObjectRequest
(v1.0) A new purchaseInvoice has been succesfully created
POST /companies({company_id})/purchaseInvoices
/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/Microsoft.NAV.post
| 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 |
(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
/companies({company_id})/purchaseInvoiceLines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
PurchaseInvoiceLineCreateD365ObjectRequest
(v1.0) A new purchaseInvoiceLine has been succesfully created
POST /companies({company_id})/purchaseInvoiceLines
/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines
| 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 |
application/json
PurchaseInvoiceLineCreateD365ObjectRequest
(v1.0) A new purchaseInvoiceLine has been succesfully created
POST /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines
/companies({company_id})/salesCreditMemos
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesCreditMemoCreateDynamicsObjectRequest
(v1.0) A new salesCreditMemo has been succesfully created
POST /companies({company_id})/salesCreditMemos
/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancel
| 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 |
(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
/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancelAndSend
| 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 |
(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
/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.post
| 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 |
(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
/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.postAndSend
| 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 |
(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
/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.send
| 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 |
(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
/companies({company_id})/salesCreditMemoLines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesCreditMemoLineCreateD365ObjectRequest
(v1.0) A new salesCreditMemoLine has been succesfully created
POST /companies({company_id})/salesCreditMemoLines
/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines
| 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 |
application/json
SalesCreditMemoLineCreateD365ObjectRequest
(v1.0) A new salesCreditMemoLine has been succesfully created
POST /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines
/companies({company_id})/salesInvoices
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesInvoiceCreateDynamicsObjectRequest
(v1.0) A new salesInvoice has been succesfully created
POST /companies({company_id})/salesInvoices
/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancel
| 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 |
(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
/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancelAndSend
| 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 |
(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
/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.makeCorrectiveCreditMemo
| 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 |
(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
/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.post
| 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 |
(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
/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.postAndSend
| 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 |
(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
/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.send
| 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 |
(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
/companies({company_id})/salesInvoiceLines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesInvoiceLineCreateD365ObjectRequest
(v1.0) A new salesInvoiceLine has been succesfully created
POST /companies({company_id})/salesInvoiceLines
/companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines
| 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 |
application/json
SalesInvoiceLineCreateD365ObjectRequest
(v1.0) A new salesInvoiceLine has been succesfully created
POST /companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines
/companies({company_id})/salesOrders
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesOrderCreateDynamicsObjectRequest
(v1.0) A new salesOrder has been succesfully created
POST /companies({company_id})/salesOrders
/companies({company_id})/salesOrders({salesOrder_id})/Microsoft.NAV.shipAndInvoice
| 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 |
(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
/companies({company_id})/salesOrderLines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesOrderLineCreateD365ObjectRequest
(v1.0) A new salesOrderLine has been succesfully created
POST /companies({company_id})/salesOrderLines
/companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines
| 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 |
application/json
SalesOrderLineCreateD365ObjectRequest
(v1.0) A new salesOrderLine has been succesfully created
POST /companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines
/companies({company_id})/salesQuotes
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesQuoteCreateD365ObjectRequest
(v1.0) A new salesQuote has been succesfully created
POST /companies({company_id})/salesQuotes
/companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeInvoice
| 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 |
(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
/companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeOrder
| 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 |
(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
/companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.send
| 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 |
(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
/companies({company_id})/salesQuoteLines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
SalesQuoteLineCreateD365ObjectRequest
(v1.0) A new salesQuoteLine has been succesfully created
POST /companies({company_id})/salesQuoteLines
/companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines
| 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 |
application/json
SalesQuoteLineCreateD365ObjectRequest
(v1.0) A new salesQuoteLine has been succesfully created
POST /companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines
/companies({company_id})/shipmentMethods
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
ShipmentMethodCreateDynamicsObjectRequest
(v1.0) A new shipmentMethod has been succesfully created
POST /companies({company_id})/shipmentMethods
/companies({company_id})/taxAreas
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
TaxAreaCreateD365ObjectRequest
(v1.0) A new taxArea has been succesfully created
POST /companies({company_id})/taxAreas
/companies({company_id})/taxGroups
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
TaxGroupCreateDynamicsObjectRequest
(v1.0) A new taxGroup has been succesfully created
POST /companies({company_id})/taxGroups
/companies({company_id})/employees({employee_id})/timeRegistrationEntries
| 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 |
application/json
TimeRegistrationEntryCreateDynamicsObjectRequest
(v1.0) A new timeRegistrationEntry has been succesfully created
POST /companies({company_id})/employees({employee_id})/timeRegistrationEntries
/companies({company_id})/timeRegistrationEntries
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
TimeRegistrationEntryCreateDynamicsObjectRequest
(v1.0) A new timeRegistrationEntry has been succesfully created
POST /companies({company_id})/timeRegistrationEntries
/companies({company_id})/unitsOfMeasure
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
UnitOfMeasureCreateD365ObjectRequest
(v1.0) A new unitOfMeasure has been succesfully created
POST /companies({company_id})/unitsOfMeasure
/companies({company_id})/vendors
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| company_id | path | required | string | (v1.0) id for company |
application/json
VendorCreateDynamicsObjectRequest
(v1.0) A new vendor has been succesfully created
POST /companies({company_id})/vendors
AccountGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account"
}
}
}
}
AgedAccountsPayableGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agedAccountsPayable"
}
}
}
}
AgedAccountsReceivableGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agedAccountsReceivable"
}
}
}
}
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"
}
}
}
AttachmentsGetList200Response
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachments"
}
}
}
}
AttachmentsGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachments"
}
}
}
}
BalanceSheetGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/balanceSheet"
}
}
}
}
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"
}
}
}
BankAccountGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bankAccount"
}
}
}
}
CashFlowStatementGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cashFlowStatement"
}
}
}
}
CompanyGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/company"
}
}
}
}
CompanyInformationGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/companyInformation"
}
}
}
}
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"
}
}
}
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"
}
}
}
CountryRegionGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/countryRegion"
}
}
}
}
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"
}
}
}
CurrencyGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currency"
}
}
}
}
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"
}
}
}
CustomerFinancialDetailGetList200Response
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customerFinancialDetail"
}
}
}
}
CustomerFinancialDetailGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customerFinancialDetail"
}
}
}
}
CustomerGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customer"
}
}
}
}
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"
}
}
}
CustomerPaymentGetList200Response
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customerPayment"
}
}
}
}
CustomerPaymentGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customerPayment"
}
}
}
}
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"
}
}
}
CustomerPaymentJournalGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customerPaymentJournal"
}
}
}
}
CustomerSaleListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customerSale"
}
}
}
}
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"
}
}
}
DefaultDimensionsGetList200Response
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defaultDimensions"
}
}
}
}
DefaultDimensionsGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defaultDimensions"
}
}
}
}
DimensionGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dimension"
}
}
}
}
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"
}
}
}
DimensionLineGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dimensionLine"
}
}
}
}
DimensionValueGetList200Response
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dimensionValue"
}
}
}
}
DimensionValueGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dimensionValue"
}
}
}
}
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"
}
}
}
EmployeeGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employee"
}
}
}
}
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"
}
}
}
GeneralLedgerEntryAttachmentsGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/generalLedgerEntryAttachments"
}
}
}
}
GeneralLedgerEntryGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/generalLedgerEntry"
}
}
}
}
IncomeStatementGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/incomeStatement"
}
}
}
}
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"
}
}
}
ItemCategoryGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/itemCategory"
}
}
}
}
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"
}
}
}
ItemListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/item"
}
}
}
}
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"
}
}
}
JournalGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journal"
}
}
}
}
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"
}
}
}
JournalLineGetList200Response
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalLine"
}
}
}
}
JournalLineGetListResponse
{
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalLine"
}
}
}
}
| Version | Endpoints | Schemas | Ingested | Status |
|---|---|---|---|---|
| 1.0.0 | 324 | 162 | 2026-05-11 | current |
| 1.0.0 | 324 | 162 | 2026-04-16 |