(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

GET POST PUT PATCH DELETE

Account 2 endpoints

GET /companies({company_id})/accounts Returns a list of accounts

operationId: Account_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of accounts

GET /companies({company_id})/accounts

GET /companies({company_id})/accounts({account_id}) Retrieve the properties and relationships of an object of type account for Dynamics 365 Business Central.

operationId: Account_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
account_id	path	required	string	(v1.0) id for account
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested account

GET /companies({company_id})/accounts({account_id})

Agedaccountspayable 2 endpoints

GET /companies({company_id})/agedAccountsPayable Returns a list of agedAccountsPayable

operationId: AgedAccountsPayable_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of agedAccountsPayable

GET /companies({company_id})/agedAccountsPayable

GET /companies({company_id})/agedAccountsPayable({agedAccountsPayable_vendorId}) Retrieve the properties and relationships of an object of type agedAccountsPayable for Dynamics 365 Business Central.

operationId: AgedAccountsPayable_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
agedAccountsPayable_vendorId	path	required	string	(v1.0) vendorId for agedAccountsPayable
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested agedAccountsPayable

GET /companies({company_id})/agedAccountsPayable({agedAccountsPayable_vendorId})

Agedaccountsreceivable 2 endpoints

GET /companies({company_id})/agedAccountsReceivable Returns a list of agedAccountsReceivable

operationId: AgedAccountsReceivable_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of agedAccountsReceivable

GET /companies({company_id})/agedAccountsReceivable

GET /companies({company_id})/agedAccountsReceivable({agedAccountsReceivable_customerId}) Retrieve the properties and relationships of an object of type agedAccountsReceivable for Dynamics 365 Business Central.

operationId: AgedAccountsReceivable_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
agedAccountsReceivable_customerId	path	required	string	(v1.0) customerId for agedAccountsReceivable
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested agedAccountsReceivable

GET /companies({company_id})/agedAccountsReceivable({agedAccountsReceivable_customerId})

Attachments 15 endpoints

GET /companies({company_id})/attachments Returns a list of attachments

operationId: Attachments_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of attachments

GET /companies({company_id})/attachments

POST /companies({company_id})/attachments Creates an object of type attachments in Dynamics 365 Business Central

operationId: Attachments_createDynamicsObject

Parameters

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

Request Body

application/json

schema AttachmentsCreateD365ObjectRequest

Responses

201

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

POST /companies({company_id})/attachments

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

GET /companies({company_id})/attachments({attachments_parentId},{attachments_id}) Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.

operationId: Attachments_getProperties

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
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested attachments

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

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

operationId: Attachments_updateDynamicsObject

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
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema AttachmentsCreateD365ObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedattachments

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

GET /companies({company_id})/journalLines({journalLine_id})/attachments Returns a list of attachments

operationId: Attachments_getList

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
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of attachments

GET /companies({company_id})/journalLines({journalLine_id})/attachments

POST /companies({company_id})/journalLines({journalLine_id})/attachments Creates an object of type attachments in Dynamics 365 Business Central

operationId: Attachments_createDynamicsObject

Parameters

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

Request Body

application/json

schema AttachmentsCreateD365ObjectRequest

Responses

201

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

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

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

GET /companies({company_id})/journalLines({journalLine_id})/attachments({attachments_parentId},{attachments_id}) Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.

operationId: Attachments_getProperties

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
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested attachments

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

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

operationId: Attachments_updateDynamicsObject

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
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema AttachmentsCreateD365ObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedattachments

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

GET /companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments Returns a list of attachments

operationId: Attachments_getList

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
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of attachments

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

POST /companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments Creates an object of type attachments in Dynamics 365 Business Central

operationId: Attachments_createD365Object

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
journal_id	path	required	string	(v1.0) id for journal
journalLine_id	path	required	string	(v1.0) id for journalLine

Request Body

application/json

schema AttachmentsCreateD365ObjectRequest

Responses

201

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

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

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

GET

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

Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.

operationId: Attachments_getProperties

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
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested attachments

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

PATCH

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

Updates an object of type attachments in Dynamics 365 Business Central

operationId: Attachments_updateD365Object

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
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema AttachmentsCreateD365ObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedattachments

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

Balancesheet 2 endpoints

GET /companies({company_id})/balanceSheet Returns a list of balanceSheet

operationId: BalanceSheet_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of balanceSheet

GET /companies({company_id})/balanceSheet

GET /companies({company_id})/balanceSheet({balanceSheet_lineNumber}) Retrieve the properties and relationships of an object of type balanceSheet for Dynamics 365 Business Central.

operationId: BalanceSheet_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
balanceSheet_lineNumber	path	required	integer	(v1.0) lineNumber for balanceSheet
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested balanceSheet

GET /companies({company_id})/balanceSheet({balanceSheet_lineNumber})

Bankaccount 5 endpoints

GET /companies({company_id})/bankAccounts Returns a list of bankAccounts

operationId: BankAccount_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of bankAccounts

GET /companies({company_id})/bankAccounts

POST /companies({company_id})/bankAccounts Creates an object of type bankAccount in Dynamics 365 Business Central

operationId: BankAccount_createDynamicsObject

Parameters

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

Request Body

application/json

schema BankAccountCreateDynamicsObjectRequest

Responses

201

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

POST /companies({company_id})/bankAccounts

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

GET /companies({company_id})/bankAccounts({bankAccount_id}) Retrieve the properties and relationships of an object of type bankAccount for Dynamics 365 Business Central.

operationId: BankAccount_getProperties

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
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested bankAccount

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

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

operationId: BankAccount_updateDynamicsObject

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
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema BankAccountCreateDynamicsObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedbankAccount

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

Cashflowstatement 2 endpoints

GET /companies({company_id})/cashFlowStatement Returns a list of cashFlowStatement

operationId: CashFlowStatement_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of cashFlowStatement

GET /companies({company_id})/cashFlowStatement

GET /companies({company_id})/cashFlowStatement({cashFlowStatement_lineNumber}) Retrieve the properties and relationships of an object of type cashFlowStatement for Dynamics 365 Business Central.

operationId: CashFlowStatement_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
cashFlowStatement_lineNumber	path	required	integer	(v1.0) lineNumber for cashFlowStatement
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested cashFlowStatement

GET /companies({company_id})/cashFlowStatement({cashFlowStatement_lineNumber})

Company 2 endpoints

GET /companies Returns a list of companies

operationId: Company_getList

Parameters

Name	In	Required	Type	Description
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of companies

GET /companies

GET /companies({company_id}) Retrieve the properties and relationships of an object of type company for Dynamics 365 Business Central.

operationId: Company_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested company

GET /companies({company_id})

Companyinformation 3 endpoints

GET /companies({company_id})/companyInformation Returns a list of companyInformation

operationId: CompanyInformation_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of companyInformation

GET /companies({company_id})/companyInformation

GET /companies({company_id})/companyInformation({companyInformation_id}) Retrieve the properties and relationships of an object of type companyInformation for Dynamics 365 Business Central.

operationId: CompanyInformation_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
companyInformation_id	path	required	string	(v1.0) id for companyInformation
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested companyInformation

GET /companies({company_id})/companyInformation({companyInformation_id})

PATCH /companies({company_id})/companyInformation({companyInformation_id}) Updates an object of type companyInformation in Dynamics 365 Business Central

operationId: CompanyInformation_updateDynamicsObject

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
companyInformation_id	path	required	string	(v1.0) id for companyInformation
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema CompanyInformationUpdateDynamicsObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedcompanyInformation

PATCH /companies({company_id})/companyInformation({companyInformation_id})

Countryregion 5 endpoints

GET /companies({company_id})/countriesRegions Returns a list of countriesRegions

operationId: CountryRegion_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of countriesRegions

GET /companies({company_id})/countriesRegions

POST /companies({company_id})/countriesRegions Creates an object of type countryRegion in Dynamics 365 Business Central

operationId: CountryRegion_createDynamicsObject

Parameters

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

Request Body

application/json

schema CountryRegionCreateDynamicsObjectRequest

Responses

201

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

POST /companies({company_id})/countriesRegions

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

GET /companies({company_id})/countriesRegions({countryRegion_id}) Retrieve the properties and relationships of an object of type countryRegion for Dynamics 365 Business Central.

operationId: CountryRegion_getProperties

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
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested countryRegion

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

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

operationId: CountryRegion_updateDynamicsObject

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
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema CountryRegionCreateDynamicsObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedcountryRegion

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

Currency 5 endpoints

GET /companies({company_id})/currencies Returns a list of currencies

operationId: Currency_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of currencies

GET /companies({company_id})/currencies

POST /companies({company_id})/currencies Creates an object of type currency in Dynamics 365 Business Central

operationId: Currency_createDynamicsObject

Parameters

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

Request Body

application/json

schema CurrencyCreateDynamicsObjectRequest

Responses

201

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

POST /companies({company_id})/currencies

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

GET /companies({company_id})/currencies({currency_id}) Retrieve the properties and relationships of an object of type currency for Dynamics 365 Business Central.

operationId: Currency_getProperties

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
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested currency

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

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

operationId: Currency_updateDynamicsObject

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
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema CurrencyCreateDynamicsObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedcurrency

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

Customer 5 endpoints

GET /companies({company_id})/customers Returns a list of customers

operationId: Customer_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
$top	query	optional	integer	(v1.0) Number of items to return from the top of the list
$skip	query	optional	integer	(v1.0) Number of items to skip from the list
$limit	query	optional	integer	(v1.0) Number of items to return from the list
$filter	query	optional	string	(v1.0) Filtering expression
$expand	query	optional	array	(v1.0) Entities to expand
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned a list of customers

GET /companies({company_id})/customers

POST /companies({company_id})/customers Creates an object of type customer in Dynamics 365 Business Central

operationId: Customer_createDynamicsObject

Parameters

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

Request Body

application/json

schema CustomerCreateDynamicsObjectRequest

Responses

201

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

POST /companies({company_id})/customers

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

GET /companies({company_id})/customers({customer_id}) Retrieve the properties and relationships of an object of type customer for Dynamics 365 Business Central.

operationId: Customer_getProperties

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
$expand	query	optional	array	(v1.0) Entities to expand
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested customer

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

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

operationId: Customer_updateDynamicsObject

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
If-Match	header	optional	string	(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Request Body

application/json

schema CustomerCreateDynamicsObjectRequest

Responses

200

(v1.0) Succesfully updated the specifiedcustomer

PATCH /companies({company_id})/customers({customer_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