(v1.0) Dynamics 365 Business Central

Business management and ERP solution

learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api ↗

Version

1.0.0

OpenAPI

3.0.0

Endpoints

324

Schemas

162

71

Quality

Updated

3 days ago

Erp erp business microsoft

Use this API in your AI agent

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

Get API Key

Server URLs

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

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

Endpoints

Clear filters

GET POST PUT PATCH DELETE

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 6 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

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

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

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

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

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

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 2 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

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

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

Countryregion 2 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

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

Currency 2 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

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

Customer 2 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

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

Customerfinancialdetail 4 endpoints

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

operationId: CustomerFinancialDetail_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 customerFinancialDetails

GET /companies({company_id})/customerFinancialDetails

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

operationId: CustomerFinancialDetail_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested customerFinancialDetail

GET /companies({company_id})/customerFinancialDetails({customerFinancialDetail_id})

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

operationId: CustomerFinancialDetail_getList

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
$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 customerFinancialDetails

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

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

operationId: CustomerFinancialDetail_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
customerFinancialDetail_id	path	required	string	(v1.0) id for customerFinancialDetail
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested customerFinancialDetail

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

Customerpayment 4 endpoints

GET /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments Returns a list of customerPayments

operationId: CustomerPayment_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
customerPaymentJournal_id	path	required	string	(v1.0) id for customerPaymentJournal
$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 customerPayments

GET /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments

GET /companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments({customerPayment_id}) Retrieve the properties and relationships of an object of type customerPayment for Dynamics 365 Business Central.

operationId: CustomerPayment_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
customerPaymentJournal_id	path	required	string	(v1.0) id for customerPaymentJournal
customerPayment_id	path	required	string	(v1.0) id for customerPayment
$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 customerPayment

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

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

operationId: CustomerPayment_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 customerPayments

GET /companies({company_id})/customerPayments

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

operationId: CustomerPayment_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
customerPayment_id	path	required	string	(v1.0) id for customerPayment
$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 customerPayment

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

Customerpaymentjournal 2 endpoints

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

operationId: CustomerPaymentJournal_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 customerPaymentJournals

GET /companies({company_id})/customerPaymentJournals

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

operationId: CustomerPaymentJournal_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
customerPaymentJournal_id	path	required	string	(v1.0) id for customerPaymentJournal
$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 customerPaymentJournal

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

Customersale 2 endpoints

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

operationId: CustomerSale_list

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 customerSales

GET /companies({company_id})/customerSales

GET /companies({company_id})/customerSales({customerSale_customerId},'{customerSale_customerNumber}','{customerSale_name}') Retrieve the properties and relationships of an object of type customerSale for Dynamics 365 Business Central.

operationId: CustomerSale_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
customerSale_customerId	path	required	string	(v1.0) customerId for customerSale
customerSale_customerNumber	path	required	string	(v1.0) customerNumber for customerSale
customerSale_name	path	required	string	(v1.0) name for customerSale
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested customerSale

GET /companies({company_id})/customerSales({customerSale_customerId},'{customerSale_customerNumber}','{customerSale_name}')

Defaultdimensions 10 endpoints

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

operationId: DefaultDimensions_getList

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
$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 defaultDimensions

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

GET

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

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

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

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

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

operationId: DefaultDimensions_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 defaultDimensions

GET /companies({company_id})/defaultDimensions

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

operationId: DefaultDimensions_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions
$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 defaultDimensions

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

GET /companies({company_id})/employees({employee_id})/defaultDimensions Returns a list of defaultDimensions

operationId: DefaultDimensions_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
employee_id	path	required	string	(v1.0) id for employee
$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 defaultDimensions

GET /companies({company_id})/employees({employee_id})/defaultDimensions

GET

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

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

operationId: DefaultDimensions_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
employee_id	path	required	string	(v1.0) id for employee
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions
$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 defaultDimensions

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

GET /companies({company_id})/items({item_id})/defaultDimensions Returns a list of defaultDimensions

operationId: DefaultDimensions_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
item_id	path	required	string	(v1.0) id for item
$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 defaultDimensions

GET /companies({company_id})/items({item_id})/defaultDimensions

GET

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

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

operationId: DefaultDimensions_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
item_id	path	required	string	(v1.0) id for item
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions
$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 defaultDimensions

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

GET /companies({company_id})/vendors({vendor_id})/defaultDimensions Returns a list of defaultDimensions

operationId: DefaultDimensions_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
vendor_id	path	required	string	(v1.0) id for vendor
$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 defaultDimensions

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

GET

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

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

operationId: DefaultDimensions_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
vendor_id	path	required	string	(v1.0) id for vendor
defaultDimensions_parentId	path	required	string	(v1.0) parentId for defaultDimensions
defaultDimensions_dimensionId	path	required	string	(v1.0) dimensionId for defaultDimensions
$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 defaultDimensions

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

Dimension 2 endpoints

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

operationId: Dimension_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 dimensions

GET /companies({company_id})/dimensions

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

operationId: Dimension_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
dimension_id	path	required	string	(v1.0) id for dimension
$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 dimension

GET /companies({company_id})/dimensions({dimension_id})

Dimensionline 2 endpoints

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

operationId: DimensionLine_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 dimensionLines

GET /companies({company_id})/dimensionLines

GET /companies({company_id})/dimensionLines({dimensionLine_parentId},{dimensionLine_id}) Retrieve the properties and relationships of an object of type dimensionLine for Dynamics 365 Business Central.

operationId: DimensionLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
dimensionLine_parentId	path	required	string	(v1.0) parentId for dimensionLine
dimensionLine_id	path	required	string	(v1.0) id for dimensionLine
$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 dimensionLine

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

Dimensionvalue 4 endpoints

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

operationId: DimensionValue_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 dimensionValues

GET /companies({company_id})/dimensionValues

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

operationId: DimensionValue_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested dimensionValue

GET /companies({company_id})/dimensionValues({dimensionValue_id})

GET /companies({company_id})/dimensions({dimension_id})/dimensionValues Returns a list of dimensionValues

operationId: DimensionValue_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
dimension_id	path	required	string	(v1.0) id for dimension
$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 dimensionValues

GET /companies({company_id})/dimensions({dimension_id})/dimensionValues

GET /companies({company_id})/dimensions({dimension_id})/dimensionValues({dimensionValue_id}) Retrieve the properties and relationships of an object of type dimensionValue for Dynamics 365 Business Central.

operationId: DimensionValue_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested dimensionValue

GET /companies({company_id})/dimensions({dimension_id})/dimensionValues({dimensionValue_id})

Employee 2 endpoints

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

operationId: Employee_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 employees

GET /companies({company_id})/employees

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

operationId: Employee_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
employee_id	path	required	string	(v1.0) id for employee
$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 employee

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

Generalledgerentry 2 endpoints

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

operationId: GeneralLedgerEntry_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 generalLedgerEntries

GET /companies({company_id})/generalLedgerEntries

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

operationId: GeneralLedgerEntry_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
generalLedgerEntry_id	path	required	integer	(v1.0) id for generalLedgerEntry
$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 generalLedgerEntry

GET /companies({company_id})/generalLedgerEntries({generalLedgerEntry_id})

Generalledgerentryattachments 2 endpoints

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

operationId: GeneralLedgerEntryAttachments_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 generalLedgerEntryAttachments

GET /companies({company_id})/generalLedgerEntryAttachments

GET

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

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

operationId: GeneralLedgerEntryAttachments_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
generalLedgerEntryAttachments_generalLedgerEntryNumber	path	required	integer	(v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments
generalLedgerEntryAttachments_id	path	required	string	(v1.0) id for generalLedgerEntryAttachments
$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 generalLedgerEntryAttachments

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

Incomestatement 2 endpoints

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

operationId: IncomeStatement_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 incomeStatement

GET /companies({company_id})/incomeStatement

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

operationId: IncomeStatement_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested incomeStatement

GET /companies({company_id})/incomeStatement({incomeStatement_lineNumber})

Item 2 endpoints

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

operationId: Item_list

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 items

GET /companies({company_id})/items

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

operationId: Item_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
item_id	path	required	string	(v1.0) id for item
$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 item

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

Itemcategory 2 endpoints

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

operationId: ItemCategory_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 itemCategories

GET /companies({company_id})/itemCategories

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

operationId: ItemCategory_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested itemCategory

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

Journal 2 endpoints

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

operationId: Journal_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 journals

GET /companies({company_id})/journals

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

operationId: Journal_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
$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 journal

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

Journalline 4 endpoints

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

operationId: JournalLine_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 journalLines

GET /companies({company_id})/journalLines

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

operationId: JournalLine_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
$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 journalLine

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

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

operationId: JournalLine_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
$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 journalLines

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

GET /companies({company_id})/journals({journal_id})/journalLines({journalLine_id}) Retrieve the properties and relationships of an object of type journalLine for Dynamics 365 Business Central.

operationId: JournalLine_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
$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 journalLine

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

Paymentmethod 2 endpoints

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

operationId: PaymentMethod_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 paymentMethods

GET /companies({company_id})/paymentMethods

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

operationId: PaymentMethod_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested paymentMethod

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

Paymentterm 2 endpoints

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

operationId: PaymentTerm_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 paymentTerms

GET /companies({company_id})/paymentTerms

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

operationId: PaymentTerm_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested paymentTerm

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

Pdfdocument 10 endpoints

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

operationId: PdfDocument_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 pdfDocument

GET /companies({company_id})/pdfDocument

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

operationId: PdfDocument_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested pdfDocument

GET /companies({company_id})/pdfDocument({pdfDocument_id})

GET /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/pdfDocument Returns a list of pdfDocument

operationId: PdfDocument_getPdf

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
purchaseInvoice_id	path	required	string	(v1.0) id for purchaseInvoice
$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 pdfDocument

GET /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/pdfDocument

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

operationId: PdfDocument_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested pdfDocument

GET /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/pdfDocument({pdfDocument_id})

GET /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/pdfDocument Returns a list of pdfDocument

operationId: PdfDocument_getDocument

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesCreditMemo_id	path	required	string	(v1.0) id for salesCreditMemo
$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 pdfDocument

GET /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/pdfDocument

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

operationId: PdfDocument_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested pdfDocument

GET /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/pdfDocument({pdfDocument_id})

GET /companies({company_id})/salesInvoices({salesInvoice_id})/pdfDocument Returns a list of pdfDocument

operationId: PdfDocument_getPdf

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesInvoice_id	path	required	string	(v1.0) id for salesInvoice
$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 pdfDocument

GET /companies({company_id})/salesInvoices({salesInvoice_id})/pdfDocument

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

operationId: PdfDocument_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested pdfDocument

GET /companies({company_id})/salesInvoices({salesInvoice_id})/pdfDocument({pdfDocument_id})

GET /companies({company_id})/salesQuotes({salesQuote_id})/pdfDocument Returns a list of pdfDocument

operationId: PdfDocument_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesQuote_id	path	required	string	(v1.0) id for salesQuote
$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 pdfDocument

GET /companies({company_id})/salesQuotes({salesQuote_id})/pdfDocument

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

operationId: PdfDocument_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested pdfDocument

GET /companies({company_id})/salesQuotes({salesQuote_id})/pdfDocument({pdfDocument_id})

Picture 10 endpoints

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

operationId: Picture_getList

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
$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 picture

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

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

operationId: Picture_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
picture_id	path	required	string	(v1.0) id for picture
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested picture

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

GET /companies({company_id})/employees({employee_id})/picture Returns a list of picture

operationId: Picture_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
employee_id	path	required	string	(v1.0) id for employee
$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 picture

GET /companies({company_id})/employees({employee_id})/picture

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

operationId: Picture_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested picture

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

GET /companies({company_id})/items({item_id})/picture Returns a list of picture

operationId: Picture_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
item_id	path	required	string	(v1.0) id for item
$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 picture

GET /companies({company_id})/items({item_id})/picture

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

operationId: Picture_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested picture

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

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

operationId: Picture_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 picture

GET /companies({company_id})/picture

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

operationId: Picture_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested picture

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

GET /companies({company_id})/vendors({vendor_id})/picture Returns a list of picture

operationId: Picture_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
vendor_id	path	required	string	(v1.0) id for vendor
$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 picture

GET /companies({company_id})/vendors({vendor_id})/picture

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

operationId: Picture_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested picture

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

Project 2 endpoints

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

operationId: Project_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 projects

GET /companies({company_id})/projects

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

operationId: Project_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested project

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

Purchaseinvoice 2 endpoints

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

operationId: PurchaseInvoice_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 purchaseInvoices

GET /companies({company_id})/purchaseInvoices

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

operationId: PurchaseInvoice_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
purchaseInvoice_id	path	required	string	(v1.0) id for purchaseInvoice
$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 purchaseInvoice

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

Purchaseinvoiceline 4 endpoints

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

operationId: PurchaseInvoiceLine_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 purchaseInvoiceLines

GET /companies({company_id})/purchaseInvoiceLines

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

operationId: PurchaseInvoiceLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
purchaseInvoiceLine_id	path	required	string	(v1.0) id for purchaseInvoiceLine
$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 purchaseInvoiceLine

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

GET /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines Returns a list of purchaseInvoiceLines

operationId: PurchaseInvoiceLine_list

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
purchaseInvoice_id	path	required	string	(v1.0) id for purchaseInvoice
$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 purchaseInvoiceLines

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

GET /companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}') Retrieve the properties and relationships of an object of type purchaseInvoiceLine for Dynamics 365 Business Central.

operationId: PurchaseInvoiceLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
purchaseInvoice_id	path	required	string	(v1.0) id for purchaseInvoice
purchaseInvoiceLine_id	path	required	string	(v1.0) id for purchaseInvoiceLine
$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 purchaseInvoiceLine

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

Retainedearningsstatement 2 endpoints

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

operationId: RetainedEarningsStatement_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 retainedEarningsStatement

GET /companies({company_id})/retainedEarningsStatement

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

operationId: RetainedEarningsStatement_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested retainedEarningsStatement

GET /companies({company_id})/retainedEarningsStatement({retainedEarningsStatement_lineNumber})

Salescreditmemo 2 endpoints

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

operationId: SalesCreditMemo_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 salesCreditMemos

GET /companies({company_id})/salesCreditMemos

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

operationId: SalesCreditMemo_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesCreditMemo_id	path	required	string	(v1.0) id for salesCreditMemo
$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 salesCreditMemo

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

Salescreditmemoline 4 endpoints

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

operationId: SalesCreditMemoLine_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 salesCreditMemoLines

GET /companies({company_id})/salesCreditMemoLines

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

operationId: SalesCreditMemoLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesCreditMemoLine_id	path	required	string	(v1.0) id for salesCreditMemoLine
$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 salesCreditMemoLine

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

GET /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines Returns a list of salesCreditMemoLines

operationId: SalesCreditMemoLine_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesCreditMemo_id	path	required	string	(v1.0) id for salesCreditMemo
$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 salesCreditMemoLines

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

GET /companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines('{salesCreditMemoLine_id}') Retrieve the properties and relationships of an object of type salesCreditMemoLine for Dynamics 365 Business Central.

operationId: SalesCreditMemoLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesCreditMemo_id	path	required	string	(v1.0) id for salesCreditMemo
salesCreditMemoLine_id	path	required	string	(v1.0) id for salesCreditMemoLine
$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 salesCreditMemoLine

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

Salesinvoice 2 endpoints

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

operationId: SalesInvoice_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 salesInvoices

GET /companies({company_id})/salesInvoices

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

operationId: SalesInvoice_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesInvoice_id	path	required	string	(v1.0) id for salesInvoice
$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 salesInvoice

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

Salesinvoiceline 4 endpoints

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

operationId: SalesInvoiceLine_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 salesInvoiceLines

GET /companies({company_id})/salesInvoiceLines

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

operationId: SalesInvoiceLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesInvoiceLine_id	path	required	string	(v1.0) id for salesInvoiceLine
$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 salesInvoiceLine

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

GET /companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines Returns a list of salesInvoiceLines

operationId: SalesInvoiceLine_list

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesInvoice_id	path	required	string	(v1.0) id for salesInvoice
$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 salesInvoiceLines

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

GET /companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines('{salesInvoiceLine_id}') Retrieve the properties and relationships of an object of type salesInvoiceLine for Dynamics 365 Business Central.

operationId: SalesInvoiceLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesInvoice_id	path	required	string	(v1.0) id for salesInvoice
salesInvoiceLine_id	path	required	string	(v1.0) id for salesInvoiceLine
$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 salesInvoiceLine

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

Salesorder 2 endpoints

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

operationId: SalesOrder_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 salesOrders

GET /companies({company_id})/salesOrders

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

operationId: SalesOrder_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesOrder_id	path	required	string	(v1.0) id for salesOrder
$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 salesOrder

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

Salesorderline 4 endpoints

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

operationId: SalesOrderLine_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 salesOrderLines

GET /companies({company_id})/salesOrderLines

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

operationId: SalesOrderLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesOrderLine_id	path	required	string	(v1.0) id for salesOrderLine
$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 salesOrderLine

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

GET /companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines Returns a list of salesOrderLines

operationId: SalesOrderLine_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesOrder_id	path	required	string	(v1.0) id for salesOrder
$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 salesOrderLines

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

GET /companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines('{salesOrderLine_id}') Retrieve the properties and relationships of an object of type salesOrderLine for Dynamics 365 Business Central.

operationId: SalesOrderLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesOrder_id	path	required	string	(v1.0) id for salesOrder
salesOrderLine_id	path	required	string	(v1.0) id for salesOrderLine
$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 salesOrderLine

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

Salesquote 2 endpoints

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

operationId: SalesQuote_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 salesQuotes

GET /companies({company_id})/salesQuotes

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

operationId: SalesQuote_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesQuote_id	path	required	string	(v1.0) id for salesQuote
$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 salesQuote

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

Salesquoteline 4 endpoints

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

operationId: SalesQuoteLine_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 salesQuoteLines

GET /companies({company_id})/salesQuoteLines

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

operationId: SalesQuoteLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesQuoteLine_id	path	required	string	(v1.0) id for salesQuoteLine
$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 salesQuoteLine

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

GET /companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines Returns a list of salesQuoteLines

operationId: SalesQuoteLine_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesQuote_id	path	required	string	(v1.0) id for salesQuote
$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 salesQuoteLines

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

GET /companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines('{salesQuoteLine_id}') Retrieve the properties and relationships of an object of type salesQuoteLine for Dynamics 365 Business Central.

operationId: SalesQuoteLine_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
salesQuote_id	path	required	string	(v1.0) id for salesQuote
salesQuoteLine_id	path	required	string	(v1.0) id for salesQuoteLine
$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 salesQuoteLine

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

Shipmentmethod 2 endpoints

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

operationId: ShipmentMethod_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 shipmentMethods

GET /companies({company_id})/shipmentMethods

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

operationId: ShipmentMethod_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested shipmentMethod

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

Taxarea 2 endpoints

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

operationId: TaxArea_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 taxAreas

GET /companies({company_id})/taxAreas

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

operationId: TaxArea_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested taxArea

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

Taxgroup 2 endpoints

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

operationId: TaxGroup_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 taxGroups

GET /companies({company_id})/taxGroups

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

operationId: TaxGroup_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested taxGroup

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

Timeregistrationentry 4 endpoints

GET /companies({company_id})/employees({employee_id})/timeRegistrationEntries Returns a list of timeRegistrationEntries

operationId: TimeRegistrationEntry_getList

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
employee_id	path	required	string	(v1.0) id for employee
$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 timeRegistrationEntries

GET /companies({company_id})/employees({employee_id})/timeRegistrationEntries

GET /companies({company_id})/employees({employee_id})/timeRegistrationEntries({timeRegistrationEntry_id}) Retrieve the properties and relationships of an object of type timeRegistrationEntry for Dynamics 365 Business Central.

operationId: TimeRegistrationEntry_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
employee_id	path	required	string	(v1.0) id for employee
timeRegistrationEntry_id	path	required	string	(v1.0) id for timeRegistrationEntry
$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 timeRegistrationEntry

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

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

operationId: TimeRegistrationEntry_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 timeRegistrationEntries

GET /companies({company_id})/timeRegistrationEntries

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

operationId: TimeRegistrationEntry_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
timeRegistrationEntry_id	path	required	string	(v1.0) id for timeRegistrationEntry
$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 timeRegistrationEntry

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

Trialbalance 2 endpoints

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

operationId: TrialBalance_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 trialBalance

GET /companies({company_id})/trialBalance

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

operationId: TrialBalance_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
trialBalance_number	path	required	string	(v1.0) number for trialBalance
$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 trialBalance

GET /companies({company_id})/trialBalance('{trialBalance_number}')

Unitofmeasure 2 endpoints

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

operationId: UnitOfMeasure_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 unitsOfMeasure

GET /companies({company_id})/unitsOfMeasure

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

operationId: UnitOfMeasure_getProperties

Parameters

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

Responses

200

(v1.0) Succesfully returned the requested unitOfMeasure

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

Vendor 2 endpoints

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

operationId: Vendor_list

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 vendors

GET /companies({company_id})/vendors

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

operationId: Vendor_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
vendor_id	path	required	string	(v1.0) id for vendor
$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 vendor

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

Vendorpurchase 2 endpoints

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

operationId: VendorPurchase_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 vendorPurchases

GET /companies({company_id})/vendorPurchases

GET

/companies({company_id})/vendorPurchases({vendorPurchase_vendorId},'{vendorPurchase_vendorNumber}','{vendorPurchase_name}')

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

operationId: VendorPurchase_getProperties

Parameters

Name	In	Required	Type	Description
company_id	path	required	string	(v1.0) id for company
vendorPurchase_vendorId	path	required	string	(v1.0) vendorId for vendorPurchase
vendorPurchase_vendorNumber	path	required	string	(v1.0) vendorNumber for vendorPurchase
vendorPurchase_name	path	required	string	(v1.0) name for vendorPurchase
$select	query	optional	array	(v1.0) Selected properties to be retrieved

Responses

200

(v1.0) Succesfully returned the requested vendorPurchase

GET /companies({company_id})/vendorPurchases({vendorPurchase_vendorId},'{vendorPurchase_vendorNumber}','{vendorPurchase_name}')

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