microsoft.dynamics365businesscentral
Module microsoft.dynamics365businesscentral
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_microsoft.dynamics365businesscentral_1.5.1.png)
ballerinax/microsoft.dynamics365businesscentral Ballerina library
Overview
This is a generated connector from Microsoft Dynamics 365 Business Central API v1.0 OpenAPI specification.
(v1.0) Business Central Standard APIs
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Microsoft Dynamics 365 Business Central account
- Obtain tokens by following this guide
Quickstart
To use the Dynamics 365 Business Central connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/microsoft.dynamics365businesscentral
module into the Ballerina project.
import ballerinax/microsoft.dynamics365businesscentral;
Step 2: Create a new connector instance
Create a dynamics365businesscentral:ClientConfig
with the OAuth Token
obtained, and initialize the connector with it.
dynamics365businesscentral:ClientConfig clientConfig = { auth : { token: token } }; dynamics365businesscentral:Client baseClient = check new Client(clientConfig);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to list companies using the connector.
public function main() { dynamics365businesscentral:InlineResponse200|error response = baseClient->listCompanies(); if (response is dynamics365businesscentral:InlineResponse200) { log:printInfo(response.toString()); } else { log:printError(response.message()); } }
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
microsoft.dynamics365businesscentral: Client![](/images/permalink.svg)
This is a generated connector from Microsoft Dynamics 365 Business Central API v1.0 OpenAPI specification. (v1.0) Business Central Standard APIs
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an Dynamics 365 Business Central Account and obtain tokens following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v1.0" - URL of the target service
listCompanies![](/images/permalink.svg)
function listCompanies(int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse200|error
Returns a list of companies
Parameters
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse200|error - (v1.0) Succesfully returned a list of companies
getCompany![](/images/permalink.svg)
Retrieve the properties and relationships of an object of type company for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
listItems![](/images/permalink.svg)
function listItems(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2001|error
Returns a list of items
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2001|error - (v1.0) Succesfully returned a list of items
postItem![](/images/permalink.svg)
Creates an object of type item in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getItem![](/images/permalink.svg)
function getItem(string companyId, string itemId, string[]? expand, string[]? 'select) returns Item|error
Retrieve the properties and relationships of an object of type item for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteItem![](/images/permalink.svg)
Deletes an object of type item in Dynamics 365 Business Central
patchItem![](/images/permalink.svg)
function patchItem(string companyId, string itemId, string contentType, string ifMatch, json payload) returns Item|error
Updates an object of type item in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listPictureForItem![](/images/permalink.svg)
function listPictureForItem(string companyId, string itemId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2002|error
Returns a list of picture
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2002|error - (v1.0) Succesfully returned a list of picture
getPictureForItem![](/images/permalink.svg)
function getPictureForItem(string companyId, string itemId, string pictureId, string[]? 'select) returns Picture|error
Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- pictureId string - (v1.0) id for picture
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deletePictureForItem![](/images/permalink.svg)
function deletePictureForItem(string companyId, string itemId, string pictureId) returns Response|error
Deletes an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- pictureId string - (v1.0) id for picture
patchPictureForItem![](/images/permalink.svg)
function patchPictureForItem(string companyId, string itemId, string pictureId, string contentType, string ifMatch, json payload) returns Picture|error
Updates an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- pictureId string - (v1.0) id for picture
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listDefaultDimensionsForItem![](/images/permalink.svg)
function listDefaultDimensionsForItem(string companyId, string itemId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2003|error
Returns a list of defaultDimensions
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2003|error - (v1.0) Succesfully returned a list of defaultDimensions
postDefaultDimensionsForItem![](/images/permalink.svg)
function postDefaultDimensionsForItem(string companyId, string itemId, string contentType, json payload) returns DefaultDimensions|error
Creates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- contentType string - (v1.0) application/json
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) A new defaultDimensions has been succesfully created
getDefaultDimensionsForItem![](/images/permalink.svg)
function getDefaultDimensionsForItem(string companyId, string itemId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string[]? expand, string[]? 'select) returns DefaultDimensions|error
Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DefaultDimensions|error - (v1.0) Succesfully returned the requested defaultDimensions
deleteDefaultDimensionsForItem![](/images/permalink.svg)
function deleteDefaultDimensionsForItem(string companyId, string itemId, string defaultdimensionsParentid, string defaultdimensionsDimensionid) returns Response|error
Deletes an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
patchDefaultDimensionsForItem![](/images/permalink.svg)
function patchDefaultDimensionsForItem(string companyId, string itemId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string contentType, string ifMatch, json payload) returns DefaultDimensions|error
Updates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemId string - (v1.0) id for item
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) Succesfully updated the specifieddefaultDimensions
listPicture![](/images/permalink.svg)
function listPicture(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2002|error
Returns a list of picture
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2002|error - (v1.0) Succesfully returned a list of picture
getPicture![](/images/permalink.svg)
Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- pictureId string - (v1.0) id for picture
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deletePicture![](/images/permalink.svg)
Deletes an object of type picture in Dynamics 365 Business Central
patchPicture![](/images/permalink.svg)
function patchPicture(string companyId, string pictureId, string contentType, string ifMatch, json payload) returns Picture|error
Updates an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- pictureId string - (v1.0) id for picture
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listDefaultDimensions![](/images/permalink.svg)
function listDefaultDimensions(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2003|error
Returns a list of defaultDimensions
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2003|error - (v1.0) Succesfully returned a list of defaultDimensions
postDefaultDimensions![](/images/permalink.svg)
function postDefaultDimensions(string companyId, string contentType, json payload) returns DefaultDimensions|error
Creates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) A new defaultDimensions has been succesfully created
getDefaultDimensions![](/images/permalink.svg)
function getDefaultDimensions(string companyId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string[]? expand, string[]? 'select) returns DefaultDimensions|error
Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DefaultDimensions|error - (v1.0) Succesfully returned the requested defaultDimensions
deleteDefaultDimensions![](/images/permalink.svg)
function deleteDefaultDimensions(string companyId, string defaultdimensionsParentid, string defaultdimensionsDimensionid) returns Response|error
Deletes an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
patchDefaultDimensions![](/images/permalink.svg)
function patchDefaultDimensions(string companyId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string contentType, string ifMatch, json payload) returns DefaultDimensions|error
Updates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) Succesfully updated the specifieddefaultDimensions
listCustomers![](/images/permalink.svg)
function listCustomers(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2004|error
Returns a list of customers
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2004|error - (v1.0) Succesfully returned a list of customers
postCustomer![](/images/permalink.svg)
Creates an object of type customer in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getCustomer![](/images/permalink.svg)
function getCustomer(string companyId, string customerId, string[]? expand, string[]? 'select) returns Customer|error
Retrieve the properties and relationships of an object of type customer for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteCustomer![](/images/permalink.svg)
Deletes an object of type customer in Dynamics 365 Business Central
patchCustomer![](/images/permalink.svg)
function patchCustomer(string companyId, string customerId, string contentType, string ifMatch, json payload) returns Customer|error
Updates an object of type customer in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listCustomerFinancialDetailsForCustomer![](/images/permalink.svg)
function listCustomerFinancialDetailsForCustomer(string companyId, string customerId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2005|error
Returns a list of customerFinancialDetails
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2005|error - (v1.0) Succesfully returned a list of customerFinancialDetails
getCustomerFinancialDetailForCustomer![](/images/permalink.svg)
function getCustomerFinancialDetailForCustomer(string companyId, string customerId, string customerfinancialdetailId, string[]? 'select) returns CustomerFinancialDetail|error
Retrieve the properties and relationships of an object of type customerFinancialDetail for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- customerfinancialdetailId string - (v1.0) id for customerFinancialDetail
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CustomerFinancialDetail|error - (v1.0) Succesfully returned the requested customerFinancialDetail
listPictureForCustomer![](/images/permalink.svg)
function listPictureForCustomer(string companyId, string customerId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2002|error
Returns a list of picture
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2002|error - (v1.0) Succesfully returned a list of picture
getPictureForCustomer![](/images/permalink.svg)
function getPictureForCustomer(string companyId, string customerId, string pictureId, string[]? 'select) returns Picture|error
Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- pictureId string - (v1.0) id for picture
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deletePictureForCustomer![](/images/permalink.svg)
function deletePictureForCustomer(string companyId, string customerId, string pictureId) returns Response|error
Deletes an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- pictureId string - (v1.0) id for picture
patchPictureForCustomer![](/images/permalink.svg)
function patchPictureForCustomer(string companyId, string customerId, string pictureId, string contentType, string ifMatch, json payload) returns Picture|error
Updates an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- pictureId string - (v1.0) id for picture
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listDefaultDimensionsForCustomer![](/images/permalink.svg)
function listDefaultDimensionsForCustomer(string companyId, string customerId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2003|error
Returns a list of defaultDimensions
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2003|error - (v1.0) Succesfully returned a list of defaultDimensions
postDefaultDimensionsForCustomer![](/images/permalink.svg)
function postDefaultDimensionsForCustomer(string companyId, string customerId, string contentType, json payload) returns DefaultDimensions|error
Creates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- contentType string - (v1.0) application/json
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) A new defaultDimensions has been succesfully created
getDefaultDimensionsForCustomer![](/images/permalink.svg)
function getDefaultDimensionsForCustomer(string companyId, string customerId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string[]? expand, string[]? 'select) returns DefaultDimensions|error
Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DefaultDimensions|error - (v1.0) Succesfully returned the requested defaultDimensions
deleteDefaultDimensionsForCustomer![](/images/permalink.svg)
function deleteDefaultDimensionsForCustomer(string companyId, string customerId, string defaultdimensionsParentid, string defaultdimensionsDimensionid) returns Response|error
Deletes an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
patchDefaultDimensionsForCustomer![](/images/permalink.svg)
function patchDefaultDimensionsForCustomer(string companyId, string customerId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string contentType, string ifMatch, json payload) returns DefaultDimensions|error
Updates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerId string - (v1.0) id for customer
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) Succesfully updated the specifieddefaultDimensions
listCustomerFinancialDetails![](/images/permalink.svg)
function listCustomerFinancialDetails(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2005|error
Returns a list of customerFinancialDetails
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2005|error - (v1.0) Succesfully returned a list of customerFinancialDetails
getCustomerFinancialDetail![](/images/permalink.svg)
function getCustomerFinancialDetail(string companyId, string customerfinancialdetailId, string[]? 'select) returns CustomerFinancialDetail|error
Retrieve the properties and relationships of an object of type customerFinancialDetail for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerfinancialdetailId string - (v1.0) id for customerFinancialDetail
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CustomerFinancialDetail|error - (v1.0) Succesfully returned the requested customerFinancialDetail
listVendors![](/images/permalink.svg)
function listVendors(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2006|error
Returns a list of vendors
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2006|error - (v1.0) Succesfully returned a list of vendors
postVendor![](/images/permalink.svg)
Creates an object of type vendor in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getVendor![](/images/permalink.svg)
function getVendor(string companyId, string vendorId, string[]? expand, string[]? 'select) returns Vendor|error
Retrieve the properties and relationships of an object of type vendor for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteVendor![](/images/permalink.svg)
Deletes an object of type vendor in Dynamics 365 Business Central
patchVendor![](/images/permalink.svg)
function patchVendor(string companyId, string vendorId, string contentType, string ifMatch, json payload) returns Vendor|error
Updates an object of type vendor in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listPictureForVendor![](/images/permalink.svg)
function listPictureForVendor(string companyId, string vendorId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2002|error
Returns a list of picture
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2002|error - (v1.0) Succesfully returned a list of picture
getPictureForVendor![](/images/permalink.svg)
function getPictureForVendor(string companyId, string vendorId, string pictureId, string[]? 'select) returns Picture|error
Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- pictureId string - (v1.0) id for picture
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deletePictureForVendor![](/images/permalink.svg)
function deletePictureForVendor(string companyId, string vendorId, string pictureId) returns Response|error
Deletes an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- pictureId string - (v1.0) id for picture
patchPictureForVendor![](/images/permalink.svg)
function patchPictureForVendor(string companyId, string vendorId, string pictureId, string contentType, string ifMatch, json payload) returns Picture|error
Updates an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- pictureId string - (v1.0) id for picture
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listDefaultDimensionsForVendor![](/images/permalink.svg)
function listDefaultDimensionsForVendor(string companyId, string vendorId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2003|error
Returns a list of defaultDimensions
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2003|error - (v1.0) Succesfully returned a list of defaultDimensions
postDefaultDimensionsForVendor![](/images/permalink.svg)
function postDefaultDimensionsForVendor(string companyId, string vendorId, string contentType, json payload) returns DefaultDimensions|error
Creates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- contentType string - (v1.0) application/json
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) A new defaultDimensions has been succesfully created
getDefaultDimensionsForVendor![](/images/permalink.svg)
function getDefaultDimensionsForVendor(string companyId, string vendorId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string[]? expand, string[]? 'select) returns DefaultDimensions|error
Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DefaultDimensions|error - (v1.0) Succesfully returned the requested defaultDimensions
deleteDefaultDimensionsForVendor![](/images/permalink.svg)
function deleteDefaultDimensionsForVendor(string companyId, string vendorId, string defaultdimensionsParentid, string defaultdimensionsDimensionid) returns Response|error
Deletes an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
patchDefaultDimensionsForVendor![](/images/permalink.svg)
function patchDefaultDimensionsForVendor(string companyId, string vendorId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string contentType, string ifMatch, json payload) returns DefaultDimensions|error
Updates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- vendorId string - (v1.0) id for vendor
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) Succesfully updated the specifieddefaultDimensions
listCompanyInformation![](/images/permalink.svg)
function listCompanyInformation(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2007|error
Returns a list of companyInformation
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2007|error - (v1.0) Succesfully returned a list of companyInformation
getCompanyInformation![](/images/permalink.svg)
function getCompanyInformation(string companyId, string companyinformationId, string[]? 'select) returns CompanyInformation|error
Retrieve the properties and relationships of an object of type companyInformation for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- companyinformationId string - (v1.0) id for companyInformation
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CompanyInformation|error - (v1.0) Succesfully returned the requested companyInformation
patchCompanyInformation![](/images/permalink.svg)
function patchCompanyInformation(string companyId, string companyinformationId, string contentType, string ifMatch, json payload) returns CompanyInformation|error
Updates an object of type companyInformation in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- companyinformationId string - (v1.0) id for companyInformation
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- CompanyInformation|error - (v1.0) Succesfully updated the specifiedcompanyInformation
listSalesInvoices![](/images/permalink.svg)
function listSalesInvoices(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2008|error
Returns a list of salesInvoices
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2008|error - (v1.0) Succesfully returned a list of salesInvoices
postSalesInvoice![](/images/permalink.svg)
function postSalesInvoice(string companyId, string contentType, json payload) returns SalesInvoice|error
Creates an object of type salesInvoice in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesInvoice|error - (v1.0) A new salesInvoice has been succesfully created
getSalesInvoice![](/images/permalink.svg)
function getSalesInvoice(string companyId, string salesinvoiceId, string[]? expand, string[]? 'select) returns SalesInvoice|error
Retrieve the properties and relationships of an object of type salesInvoice for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesInvoice|error - (v1.0) Succesfully returned the requested salesInvoice
deleteSalesInvoice![](/images/permalink.svg)
Deletes an object of type salesInvoice in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
patchSalesInvoice![](/images/permalink.svg)
function patchSalesInvoice(string companyId, string salesinvoiceId, string contentType, string ifMatch, json payload) returns SalesInvoice|error
Updates an object of type salesInvoice in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesInvoice|error - (v1.0) Succesfully updated the specifiedsalesInvoice
cancelAndSendActionSalesInvoices![](/images/permalink.svg)
function cancelAndSendActionSalesInvoices(string companyId, string salesinvoiceId) returns Response|error
Performs the cancelAndSend action for salesInvoices entity
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
Return Type
cancelActionSalesInvoices![](/images/permalink.svg)
Performs the cancel action for salesInvoices entity
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
Return Type
makeCorrectiveCreditMemoActionSalesInvoices![](/images/permalink.svg)
function makeCorrectiveCreditMemoActionSalesInvoices(string companyId, string salesinvoiceId) returns Response|error
Performs the makeCorrectiveCreditMemo action for salesInvoices entity
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
Return Type
postAndSendActionSalesInvoices![](/images/permalink.svg)
function postAndSendActionSalesInvoices(string companyId, string salesinvoiceId) returns Response|error
Performs the postAndSend action for salesInvoices entity
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
Return Type
postActionSalesInvoices![](/images/permalink.svg)
Performs the post action for salesInvoices entity
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
Return Type
sendActionSalesInvoices![](/images/permalink.svg)
Performs the send action for salesInvoices entity
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
Return Type
listSalesInvoiceLinesForSalesInvoice![](/images/permalink.svg)
function listSalesInvoiceLinesForSalesInvoice(string companyId, string salesinvoiceId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2009|error
Returns a list of salesInvoiceLines
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2009|error - (v1.0) Succesfully returned a list of salesInvoiceLines
postSalesInvoiceLineForSalesInvoice![](/images/permalink.svg)
function postSalesInvoiceLineForSalesInvoice(string companyId, string salesinvoiceId, string contentType, json payload) returns SalesInvoiceLine|error
Creates an object of type salesInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesInvoiceLine|error - (v1.0) A new salesInvoiceLine has been succesfully created
getSalesInvoiceLineForSalesInvoice![](/images/permalink.svg)
function getSalesInvoiceLineForSalesInvoice(string companyId, string salesinvoiceId, string salesinvoicelineId, string[]? expand, string[]? 'select) returns SalesInvoiceLine|error
Retrieve the properties and relationships of an object of type salesInvoiceLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- salesinvoicelineId string - (v1.0) id for salesInvoiceLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesInvoiceLine|error - (v1.0) Succesfully returned the requested salesInvoiceLine
deleteSalesInvoiceLineForSalesInvoice![](/images/permalink.svg)
function deleteSalesInvoiceLineForSalesInvoice(string companyId, string salesinvoiceId, string salesinvoicelineId) returns Response|error
Deletes an object of type salesInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- salesinvoicelineId string - (v1.0) id for salesInvoiceLine
patchSalesInvoiceLineForSalesInvoice![](/images/permalink.svg)
function patchSalesInvoiceLineForSalesInvoice(string companyId, string salesinvoiceId, string salesinvoicelineId, string contentType, string ifMatch, json payload) returns SalesInvoiceLine|error
Updates an object of type salesInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- salesinvoicelineId string - (v1.0) id for salesInvoiceLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesInvoiceLine|error - (v1.0) Succesfully updated the specifiedsalesInvoiceLine
listPdfDocumentForSalesInvoice![](/images/permalink.svg)
function listPdfDocumentForSalesInvoice(string companyId, string salesinvoiceId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20010|error
Returns a list of pdfDocument
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20010|error - (v1.0) Succesfully returned a list of pdfDocument
getPdfDocumentForSalesInvoice![](/images/permalink.svg)
function getPdfDocumentForSalesInvoice(string companyId, string salesinvoiceId, string pdfdocumentId, string[]? 'select) returns PdfDocument|error
Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesinvoiceId string - (v1.0) id for salesInvoice
- pdfdocumentId string - (v1.0) id for pdfDocument
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PdfDocument|error - (v1.0) Succesfully returned the requested pdfDocument
listSalesInvoiceLines![](/images/permalink.svg)
function listSalesInvoiceLines(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2009|error
Returns a list of salesInvoiceLines
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2009|error - (v1.0) Succesfully returned a list of salesInvoiceLines
postSalesInvoiceLine![](/images/permalink.svg)
function postSalesInvoiceLine(string companyId, string contentType, json payload) returns SalesInvoiceLine|error
Creates an object of type salesInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesInvoiceLine|error - (v1.0) A new salesInvoiceLine has been succesfully created
getSalesInvoiceLine![](/images/permalink.svg)
function getSalesInvoiceLine(string companyId, string salesinvoicelineId, string[]? expand, string[]? 'select) returns SalesInvoiceLine|error
Retrieve the properties and relationships of an object of type salesInvoiceLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesinvoicelineId string - (v1.0) id for salesInvoiceLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesInvoiceLine|error - (v1.0) Succesfully returned the requested salesInvoiceLine
deleteSalesInvoiceLine![](/images/permalink.svg)
Deletes an object of type salesInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesinvoicelineId string - (v1.0) id for salesInvoiceLine
patchSalesInvoiceLine![](/images/permalink.svg)
function patchSalesInvoiceLine(string companyId, string salesinvoicelineId, string contentType, string ifMatch, json payload) returns SalesInvoiceLine|error
Updates an object of type salesInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesinvoicelineId string - (v1.0) id for salesInvoiceLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesInvoiceLine|error - (v1.0) Succesfully updated the specifiedsalesInvoiceLine
listPdfDocument![](/images/permalink.svg)
function listPdfDocument(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20010|error
Returns a list of pdfDocument
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20010|error - (v1.0) Succesfully returned a list of pdfDocument
getPdfDocument![](/images/permalink.svg)
function getPdfDocument(string companyId, string pdfdocumentId, string[]? 'select) returns PdfDocument|error
Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- pdfdocumentId string - (v1.0) id for pdfDocument
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PdfDocument|error - (v1.0) Succesfully returned the requested pdfDocument
listCustomerPaymentJournals![](/images/permalink.svg)
function listCustomerPaymentJournals(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20011|error
Returns a list of customerPaymentJournals
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20011|error - (v1.0) Succesfully returned a list of customerPaymentJournals
postCustomerPaymentJournal![](/images/permalink.svg)
function postCustomerPaymentJournal(string companyId, string contentType, json payload) returns CustomerPaymentJournal|error
Creates an object of type customerPaymentJournal in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- CustomerPaymentJournal|error - (v1.0) A new customerPaymentJournal has been succesfully created
getCustomerPaymentJournal![](/images/permalink.svg)
function getCustomerPaymentJournal(string companyId, string customerpaymentjournalId, string[]? expand, string[]? 'select) returns CustomerPaymentJournal|error
Retrieve the properties and relationships of an object of type customerPaymentJournal for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CustomerPaymentJournal|error - (v1.0) Succesfully returned the requested customerPaymentJournal
deleteCustomerPaymentJournal![](/images/permalink.svg)
function deleteCustomerPaymentJournal(string companyId, string customerpaymentjournalId) returns Response|error
Deletes an object of type customerPaymentJournal in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
patchCustomerPaymentJournal![](/images/permalink.svg)
function patchCustomerPaymentJournal(string companyId, string customerpaymentjournalId, string contentType, string ifMatch, json payload) returns CustomerPaymentJournal|error
Updates an object of type customerPaymentJournal in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- CustomerPaymentJournal|error - (v1.0) Succesfully updated the specifiedcustomerPaymentJournal
listCustomerPaymentsForCustomerPaymentJournal![](/images/permalink.svg)
function listCustomerPaymentsForCustomerPaymentJournal(string companyId, string customerpaymentjournalId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20012|error
Returns a list of customerPayments
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20012|error - (v1.0) Succesfully returned a list of customerPayments
postCustomerPaymentForCustomerPaymentJournal![](/images/permalink.svg)
function postCustomerPaymentForCustomerPaymentJournal(string companyId, string customerpaymentjournalId, string contentType, json payload) returns CustomerPayment|error
Creates an object of type customerPayment in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
- contentType string - (v1.0) application/json
- payload json -
Return Type
- CustomerPayment|error - (v1.0) A new customerPayment has been succesfully created
getCustomerPaymentForCustomerPaymentJournal![](/images/permalink.svg)
function getCustomerPaymentForCustomerPaymentJournal(string companyId, string customerpaymentjournalId, string customerpaymentId, string[]? expand, string[]? 'select) returns CustomerPayment|error
Retrieve the properties and relationships of an object of type customerPayment for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
- customerpaymentId string - (v1.0) id for customerPayment
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CustomerPayment|error - (v1.0) Succesfully returned the requested customerPayment
deleteCustomerPaymentForCustomerPaymentJournal![](/images/permalink.svg)
function deleteCustomerPaymentForCustomerPaymentJournal(string companyId, string customerpaymentjournalId, string customerpaymentId) returns Response|error
Deletes an object of type customerPayment in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
- customerpaymentId string - (v1.0) id for customerPayment
patchCustomerPaymentForCustomerPaymentJournal![](/images/permalink.svg)
function patchCustomerPaymentForCustomerPaymentJournal(string companyId, string customerpaymentjournalId, string customerpaymentId, string contentType, string ifMatch, json payload) returns CustomerPayment|error
Updates an object of type customerPayment in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerpaymentjournalId string - (v1.0) id for customerPaymentJournal
- customerpaymentId string - (v1.0) id for customerPayment
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- CustomerPayment|error - (v1.0) Succesfully updated the specifiedcustomerPayment
listCustomerPayments![](/images/permalink.svg)
function listCustomerPayments(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20012|error
Returns a list of customerPayments
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20012|error - (v1.0) Succesfully returned a list of customerPayments
postCustomerPayment![](/images/permalink.svg)
function postCustomerPayment(string companyId, string contentType, json payload) returns CustomerPayment|error
Creates an object of type customerPayment in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- CustomerPayment|error - (v1.0) A new customerPayment has been succesfully created
getCustomerPayment![](/images/permalink.svg)
function getCustomerPayment(string companyId, string customerpaymentId, string[]? expand, string[]? 'select) returns CustomerPayment|error
Retrieve the properties and relationships of an object of type customerPayment for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customerpaymentId string - (v1.0) id for customerPayment
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CustomerPayment|error - (v1.0) Succesfully returned the requested customerPayment
deleteCustomerPayment![](/images/permalink.svg)
Deletes an object of type customerPayment in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerpaymentId string - (v1.0) id for customerPayment
patchCustomerPayment![](/images/permalink.svg)
function patchCustomerPayment(string companyId, string customerpaymentId, string contentType, string ifMatch, json payload) returns CustomerPayment|error
Updates an object of type customerPayment in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- customerpaymentId string - (v1.0) id for customerPayment
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- CustomerPayment|error - (v1.0) Succesfully updated the specifiedcustomerPayment
listAccounts![](/images/permalink.svg)
function listAccounts(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20013|error
Returns a list of accounts
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20013|error - (v1.0) Succesfully returned a list of accounts
getAccount![](/images/permalink.svg)
Retrieve the properties and relationships of an object of type account for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- accountId string - (v1.0) id for account
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
listTaxGroups![](/images/permalink.svg)
function listTaxGroups(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20014|error
Returns a list of taxGroups
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20014|error - (v1.0) Succesfully returned a list of taxGroups
postTaxGroup![](/images/permalink.svg)
Creates an object of type taxGroup in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getTaxGroup![](/images/permalink.svg)
Retrieve the properties and relationships of an object of type taxGroup for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- taxgroupId string - (v1.0) id for taxGroup
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteTaxGroup![](/images/permalink.svg)
Deletes an object of type taxGroup in Dynamics 365 Business Central
patchTaxGroup![](/images/permalink.svg)
function patchTaxGroup(string companyId, string taxgroupId, string contentType, string ifMatch, json payload) returns TaxGroup|error
Updates an object of type taxGroup in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- taxgroupId string - (v1.0) id for taxGroup
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listJournals![](/images/permalink.svg)
function listJournals(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20015|error
Returns a list of journals
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20015|error - (v1.0) Succesfully returned a list of journals
postJournal![](/images/permalink.svg)
Creates an object of type journal in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getJournal![](/images/permalink.svg)
function getJournal(string companyId, string journalId, string[]? expand, string[]? 'select) returns Journal|error
Retrieve the properties and relationships of an object of type journal for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteJournal![](/images/permalink.svg)
Deletes an object of type journal in Dynamics 365 Business Central
patchJournal![](/images/permalink.svg)
function patchJournal(string companyId, string journalId, string contentType, string ifMatch, json payload) returns Journal|error
Updates an object of type journal in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
postActionJournals![](/images/permalink.svg)
Performs the post action for journals entity
Return Type
listJournalLinesForJournal![](/images/permalink.svg)
function listJournalLinesForJournal(string companyId, string journalId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20016|error
Returns a list of journalLines
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20016|error - (v1.0) Succesfully returned a list of journalLines
postJournalLineForJournal![](/images/permalink.svg)
function postJournalLineForJournal(string companyId, string journalId, string contentType, json payload) returns JournalLine|error
Creates an object of type journalLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- contentType string - (v1.0) application/json
- payload json -
Return Type
- JournalLine|error - (v1.0) A new journalLine has been succesfully created
getJournalLineForJournal![](/images/permalink.svg)
function getJournalLineForJournal(string companyId, string journalId, string journallineId, string[]? expand, string[]? 'select) returns JournalLine|error
Retrieve the properties and relationships of an object of type journalLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- JournalLine|error - (v1.0) Succesfully returned the requested journalLine
deleteJournalLineForJournal![](/images/permalink.svg)
function deleteJournalLineForJournal(string companyId, string journalId, string journallineId) returns Response|error
Deletes an object of type journalLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
patchJournalLineForJournal![](/images/permalink.svg)
function patchJournalLineForJournal(string companyId, string journalId, string journallineId, string contentType, string ifMatch, json payload) returns JournalLine|error
Updates an object of type journalLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- JournalLine|error - (v1.0) Succesfully updated the specifiedjournalLine
listAttachmentsForJournalLineForJournal![](/images/permalink.svg)
function listAttachmentsForJournalLineForJournal(string companyId, string journalId, string journallineId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20017|error
Returns a list of attachments
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20017|error - (v1.0) Succesfully returned a list of attachments
postAttachmentsForJournalLineForJournal![](/images/permalink.svg)
function postAttachmentsForJournalLineForJournal(string companyId, string journalId, string journallineId, string contentType, json payload) returns Attachments|error
Creates an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
- contentType string - (v1.0) application/json
- payload json -
Return Type
- Attachments|error - (v1.0) A new attachments has been succesfully created
getAttachmentsForJournalLineForJournal![](/images/permalink.svg)
function getAttachmentsForJournalLineForJournal(string companyId, string journalId, string journallineId, string attachmentsParentid, string attachmentsId, string[]? 'select) returns Attachments|error
Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- Attachments|error - (v1.0) Succesfully returned the requested attachments
deleteAttachmentsForJournalLineForJournal![](/images/permalink.svg)
function deleteAttachmentsForJournalLineForJournal(string companyId, string journalId, string journallineId, string attachmentsParentid, string attachmentsId) returns Response|error
Deletes an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
patchAttachmentsForJournalLineForJournal![](/images/permalink.svg)
function patchAttachmentsForJournalLineForJournal(string companyId, string journalId, string journallineId, string attachmentsParentid, string attachmentsId, string contentType, string ifMatch, json payload) returns Attachments|error
Updates an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journalId string - (v1.0) id for journal
- journallineId string - (v1.0) id for journalLine
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- Attachments|error - (v1.0) Succesfully updated the specifiedattachments
listJournalLines![](/images/permalink.svg)
function listJournalLines(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20016|error
Returns a list of journalLines
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20016|error - (v1.0) Succesfully returned a list of journalLines
postJournalLine![](/images/permalink.svg)
function postJournalLine(string companyId, string contentType, json payload) returns JournalLine|error
Creates an object of type journalLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- JournalLine|error - (v1.0) A new journalLine has been succesfully created
getJournalLine![](/images/permalink.svg)
function getJournalLine(string companyId, string journallineId, string[]? expand, string[]? 'select) returns JournalLine|error
Retrieve the properties and relationships of an object of type journalLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- journallineId string - (v1.0) id for journalLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- JournalLine|error - (v1.0) Succesfully returned the requested journalLine
deleteJournalLine![](/images/permalink.svg)
Deletes an object of type journalLine in Dynamics 365 Business Central
patchJournalLine![](/images/permalink.svg)
function patchJournalLine(string companyId, string journallineId, string contentType, string ifMatch, json payload) returns JournalLine|error
Updates an object of type journalLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journallineId string - (v1.0) id for journalLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- JournalLine|error - (v1.0) Succesfully updated the specifiedjournalLine
listAttachmentsForJournalLine![](/images/permalink.svg)
function listAttachmentsForJournalLine(string companyId, string journallineId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20017|error
Returns a list of attachments
Parameters
- companyId string - (v1.0) id for company
- journallineId string - (v1.0) id for journalLine
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20017|error - (v1.0) Succesfully returned a list of attachments
postAttachmentsForJournalLine![](/images/permalink.svg)
function postAttachmentsForJournalLine(string companyId, string journallineId, string contentType, json payload) returns Attachments|error
Creates an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journallineId string - (v1.0) id for journalLine
- contentType string - (v1.0) application/json
- payload json -
Return Type
- Attachments|error - (v1.0) A new attachments has been succesfully created
getAttachmentsForJournalLine![](/images/permalink.svg)
function getAttachmentsForJournalLine(string companyId, string journallineId, string attachmentsParentid, string attachmentsId, string[]? 'select) returns Attachments|error
Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- journallineId string - (v1.0) id for journalLine
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- Attachments|error - (v1.0) Succesfully returned the requested attachments
deleteAttachmentsForJournalLine![](/images/permalink.svg)
function deleteAttachmentsForJournalLine(string companyId, string journallineId, string attachmentsParentid, string attachmentsId) returns Response|error
Deletes an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journallineId string - (v1.0) id for journalLine
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
patchAttachmentsForJournalLine![](/images/permalink.svg)
function patchAttachmentsForJournalLine(string companyId, string journallineId, string attachmentsParentid, string attachmentsId, string contentType, string ifMatch, json payload) returns Attachments|error
Updates an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- journallineId string - (v1.0) id for journalLine
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- Attachments|error - (v1.0) Succesfully updated the specifiedattachments
listAttachments![](/images/permalink.svg)
function listAttachments(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20017|error
Returns a list of attachments
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20017|error - (v1.0) Succesfully returned a list of attachments
postAttachments![](/images/permalink.svg)
function postAttachments(string companyId, string contentType, json payload) returns Attachments|error
Creates an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- Attachments|error - (v1.0) A new attachments has been succesfully created
getAttachments![](/images/permalink.svg)
function getAttachments(string companyId, string attachmentsParentid, string attachmentsId, string[]? 'select) returns Attachments|error
Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- Attachments|error - (v1.0) Succesfully returned the requested attachments
deleteAttachments![](/images/permalink.svg)
function deleteAttachments(string companyId, string attachmentsParentid, string attachmentsId) returns Response|error
Deletes an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
patchAttachments![](/images/permalink.svg)
function patchAttachments(string companyId, string attachmentsParentid, string attachmentsId, string contentType, string ifMatch, json payload) returns Attachments|error
Updates an object of type attachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- attachmentsParentid string - (v1.0) parentId for attachments
- attachmentsId string - (v1.0) id for attachments
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- Attachments|error - (v1.0) Succesfully updated the specifiedattachments
listEmployees![](/images/permalink.svg)
function listEmployees(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20018|error
Returns a list of employees
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20018|error - (v1.0) Succesfully returned a list of employees
postEmployee![](/images/permalink.svg)
Creates an object of type employee in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getEmployee![](/images/permalink.svg)
function getEmployee(string companyId, string employeeId, string[]? expand, string[]? 'select) returns Employee|error
Retrieve the properties and relationships of an object of type employee for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteEmployee![](/images/permalink.svg)
Deletes an object of type employee in Dynamics 365 Business Central
patchEmployee![](/images/permalink.svg)
function patchEmployee(string companyId, string employeeId, string contentType, string ifMatch, json payload) returns Employee|error
Updates an object of type employee in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listPictureForEmployee![](/images/permalink.svg)
function listPictureForEmployee(string companyId, string employeeId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse2002|error
Returns a list of picture
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2002|error - (v1.0) Succesfully returned a list of picture
getPictureForEmployee![](/images/permalink.svg)
function getPictureForEmployee(string companyId, string employeeId, string pictureId, string[]? 'select) returns Picture|error
Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- pictureId string - (v1.0) id for picture
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deletePictureForEmployee![](/images/permalink.svg)
function deletePictureForEmployee(string companyId, string employeeId, string pictureId) returns Response|error
Deletes an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- pictureId string - (v1.0) id for picture
patchPictureForEmployee![](/images/permalink.svg)
function patchPictureForEmployee(string companyId, string employeeId, string pictureId, string contentType, string ifMatch, json payload) returns Picture|error
Updates an object of type picture in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- pictureId string - (v1.0) id for picture
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listDefaultDimensionsForEmployee![](/images/permalink.svg)
function listDefaultDimensionsForEmployee(string companyId, string employeeId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse2003|error
Returns a list of defaultDimensions
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse2003|error - (v1.0) Succesfully returned a list of defaultDimensions
postDefaultDimensionsForEmployee![](/images/permalink.svg)
function postDefaultDimensionsForEmployee(string companyId, string employeeId, string contentType, json payload) returns DefaultDimensions|error
Creates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- contentType string - (v1.0) application/json
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) A new defaultDimensions has been succesfully created
getDefaultDimensionsForEmployee![](/images/permalink.svg)
function getDefaultDimensionsForEmployee(string companyId, string employeeId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string[]? expand, string[]? 'select) returns DefaultDimensions|error
Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DefaultDimensions|error - (v1.0) Succesfully returned the requested defaultDimensions
deleteDefaultDimensionsForEmployee![](/images/permalink.svg)
function deleteDefaultDimensionsForEmployee(string companyId, string employeeId, string defaultdimensionsParentid, string defaultdimensionsDimensionid) returns Response|error
Deletes an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
patchDefaultDimensionsForEmployee![](/images/permalink.svg)
function patchDefaultDimensionsForEmployee(string companyId, string employeeId, string defaultdimensionsParentid, string defaultdimensionsDimensionid, string contentType, string ifMatch, json payload) returns DefaultDimensions|error
Updates an object of type defaultDimensions in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- defaultdimensionsParentid string - (v1.0) parentId for defaultDimensions
- defaultdimensionsDimensionid string - (v1.0) dimensionId for defaultDimensions
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- DefaultDimensions|error - (v1.0) Succesfully updated the specifieddefaultDimensions
listTimeRegistrationEntriesForEmployee![](/images/permalink.svg)
function listTimeRegistrationEntriesForEmployee(string companyId, string employeeId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20019|error
Returns a list of timeRegistrationEntries
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20019|error - (v1.0) Succesfully returned a list of timeRegistrationEntries
postTimeRegistrationEntryForEmployee![](/images/permalink.svg)
function postTimeRegistrationEntryForEmployee(string companyId, string employeeId, string contentType, json payload) returns TimeRegistrationEntry|error
Creates an object of type timeRegistrationEntry in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- contentType string - (v1.0) application/json
- payload json -
Return Type
- TimeRegistrationEntry|error - (v1.0) A new timeRegistrationEntry has been succesfully created
getTimeRegistrationEntryForEmployee![](/images/permalink.svg)
function getTimeRegistrationEntryForEmployee(string companyId, string employeeId, string timeregistrationentryId, string[]? expand, string[]? 'select) returns TimeRegistrationEntry|error
Retrieve the properties and relationships of an object of type timeRegistrationEntry for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- timeregistrationentryId string - (v1.0) id for timeRegistrationEntry
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- TimeRegistrationEntry|error - (v1.0) Succesfully returned the requested timeRegistrationEntry
deleteTimeRegistrationEntryForEmployee![](/images/permalink.svg)
function deleteTimeRegistrationEntryForEmployee(string companyId, string employeeId, string timeregistrationentryId) returns Response|error
Deletes an object of type timeRegistrationEntry in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- timeregistrationentryId string - (v1.0) id for timeRegistrationEntry
patchTimeRegistrationEntryForEmployee![](/images/permalink.svg)
function patchTimeRegistrationEntryForEmployee(string companyId, string employeeId, string timeregistrationentryId, string contentType, string ifMatch, json payload) returns TimeRegistrationEntry|error
Updates an object of type timeRegistrationEntry in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- employeeId string - (v1.0) id for employee
- timeregistrationentryId string - (v1.0) id for timeRegistrationEntry
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- TimeRegistrationEntry|error - (v1.0) Succesfully updated the specifiedtimeRegistrationEntry
listTimeRegistrationEntries![](/images/permalink.svg)
function listTimeRegistrationEntries(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20019|error
Returns a list of timeRegistrationEntries
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20019|error - (v1.0) Succesfully returned a list of timeRegistrationEntries
postTimeRegistrationEntry![](/images/permalink.svg)
function postTimeRegistrationEntry(string companyId, string contentType, json payload) returns TimeRegistrationEntry|error
Creates an object of type timeRegistrationEntry in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- TimeRegistrationEntry|error - (v1.0) A new timeRegistrationEntry has been succesfully created
getTimeRegistrationEntry![](/images/permalink.svg)
function getTimeRegistrationEntry(string companyId, string timeregistrationentryId, string[]? expand, string[]? 'select) returns TimeRegistrationEntry|error
Retrieve the properties and relationships of an object of type timeRegistrationEntry for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- timeregistrationentryId string - (v1.0) id for timeRegistrationEntry
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- TimeRegistrationEntry|error - (v1.0) Succesfully returned the requested timeRegistrationEntry
deleteTimeRegistrationEntry![](/images/permalink.svg)
function deleteTimeRegistrationEntry(string companyId, string timeregistrationentryId) returns Response|error
Deletes an object of type timeRegistrationEntry in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- timeregistrationentryId string - (v1.0) id for timeRegistrationEntry
patchTimeRegistrationEntry![](/images/permalink.svg)
function patchTimeRegistrationEntry(string companyId, string timeregistrationentryId, string contentType, string ifMatch, json payload) returns TimeRegistrationEntry|error
Updates an object of type timeRegistrationEntry in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- timeregistrationentryId string - (v1.0) id for timeRegistrationEntry
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- TimeRegistrationEntry|error - (v1.0) Succesfully updated the specifiedtimeRegistrationEntry
listGeneralLedgerEntries![](/images/permalink.svg)
function listGeneralLedgerEntries(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20020|error
Returns a list of generalLedgerEntries
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20020|error - (v1.0) Succesfully returned a list of generalLedgerEntries
getGeneralLedgerEntry![](/images/permalink.svg)
function getGeneralLedgerEntry(string companyId, int generalledgerentryId, string[]? expand, string[]? 'select) returns GeneralLedgerEntry|error
Retrieve the properties and relationships of an object of type generalLedgerEntry for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- generalledgerentryId int - (v1.0) id for generalLedgerEntry
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- GeneralLedgerEntry|error - (v1.0) Succesfully returned the requested generalLedgerEntry
listCurrencies![](/images/permalink.svg)
function listCurrencies(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20021|error
Returns a list of currencies
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20021|error - (v1.0) Succesfully returned a list of currencies
postCurrency![](/images/permalink.svg)
Creates an object of type currency in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getCurrency![](/images/permalink.svg)
Retrieve the properties and relationships of an object of type currency for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- currencyId string - (v1.0) id for currency
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteCurrency![](/images/permalink.svg)
Deletes an object of type currency in Dynamics 365 Business Central
patchCurrency![](/images/permalink.svg)
function patchCurrency(string companyId, string currencyId, string contentType, string ifMatch, json payload) returns Currency|error
Updates an object of type currency in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- currencyId string - (v1.0) id for currency
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listPaymentMethods![](/images/permalink.svg)
function listPaymentMethods(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20022|error
Returns a list of paymentMethods
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20022|error - (v1.0) Succesfully returned a list of paymentMethods
postPaymentMethod![](/images/permalink.svg)
function postPaymentMethod(string companyId, string contentType, json payload) returns PaymentMethod|error
Creates an object of type paymentMethod in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- PaymentMethod|error - (v1.0) A new paymentMethod has been succesfully created
getPaymentMethod![](/images/permalink.svg)
function getPaymentMethod(string companyId, string paymentmethodId, string[]? 'select) returns PaymentMethod|error
Retrieve the properties and relationships of an object of type paymentMethod for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- paymentmethodId string - (v1.0) id for paymentMethod
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PaymentMethod|error - (v1.0) Succesfully returned the requested paymentMethod
deletePaymentMethod![](/images/permalink.svg)
Deletes an object of type paymentMethod in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- paymentmethodId string - (v1.0) id for paymentMethod
patchPaymentMethod![](/images/permalink.svg)
function patchPaymentMethod(string companyId, string paymentmethodId, string contentType, string ifMatch, json payload) returns PaymentMethod|error
Updates an object of type paymentMethod in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- paymentmethodId string - (v1.0) id for paymentMethod
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- PaymentMethod|error - (v1.0) Succesfully updated the specifiedpaymentMethod
listDimensions![](/images/permalink.svg)
function listDimensions(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20023|error
Returns a list of dimensions
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20023|error - (v1.0) Succesfully returned a list of dimensions
getDimension![](/images/permalink.svg)
function getDimension(string companyId, string dimensionId, string[]? expand, string[]? 'select) returns Dimension|error
Retrieve the properties and relationships of an object of type dimension for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- dimensionId string - (v1.0) id for dimension
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
listDimensionValuesForDimension![](/images/permalink.svg)
function listDimensionValuesForDimension(string companyId, string dimensionId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20024|error
Returns a list of dimensionValues
Parameters
- companyId string - (v1.0) id for company
- dimensionId string - (v1.0) id for dimension
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20024|error - (v1.0) Succesfully returned a list of dimensionValues
getDimensionValueForDimension![](/images/permalink.svg)
function getDimensionValueForDimension(string companyId, string dimensionId, string dimensionvalueId, string[]? 'select) returns DimensionValue|error
Retrieve the properties and relationships of an object of type dimensionValue for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- dimensionId string - (v1.0) id for dimension
- dimensionvalueId string - (v1.0) id for dimensionValue
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DimensionValue|error - (v1.0) Succesfully returned the requested dimensionValue
listDimensionValues![](/images/permalink.svg)
function listDimensionValues(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20024|error
Returns a list of dimensionValues
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20024|error - (v1.0) Succesfully returned a list of dimensionValues
getDimensionValue![](/images/permalink.svg)
function getDimensionValue(string companyId, string dimensionvalueId, string[]? 'select) returns DimensionValue|error
Retrieve the properties and relationships of an object of type dimensionValue for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- dimensionvalueId string - (v1.0) id for dimensionValue
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DimensionValue|error - (v1.0) Succesfully returned the requested dimensionValue
listDimensionLines![](/images/permalink.svg)
function listDimensionLines(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20025|error
Returns a list of dimensionLines
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20025|error - (v1.0) Succesfully returned a list of dimensionLines
postDimensionLine![](/images/permalink.svg)
function postDimensionLine(string companyId, string contentType, json payload) returns DimensionLine|error
Creates an object of type dimensionLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- DimensionLine|error - (v1.0) A new dimensionLine has been succesfully created
getDimensionLine![](/images/permalink.svg)
function getDimensionLine(string companyId, string dimensionlineParentid, string dimensionlineId, string[]? expand, string[]? 'select) returns DimensionLine|error
Retrieve the properties and relationships of an object of type dimensionLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- dimensionlineParentid string - (v1.0) parentId for dimensionLine
- dimensionlineId string - (v1.0) id for dimensionLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- DimensionLine|error - (v1.0) Succesfully returned the requested dimensionLine
deleteDimensionLine![](/images/permalink.svg)
function deleteDimensionLine(string companyId, string dimensionlineParentid, string dimensionlineId) returns Response|error
Deletes an object of type dimensionLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- dimensionlineParentid string - (v1.0) parentId for dimensionLine
- dimensionlineId string - (v1.0) id for dimensionLine
patchDimensionLine![](/images/permalink.svg)
function patchDimensionLine(string companyId, string dimensionlineParentid, string dimensionlineId, string contentType, string ifMatch, json payload) returns DimensionLine|error
Updates an object of type dimensionLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- dimensionlineParentid string - (v1.0) parentId for dimensionLine
- dimensionlineId string - (v1.0) id for dimensionLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- DimensionLine|error - (v1.0) Succesfully updated the specifieddimensionLine
listPaymentTerms![](/images/permalink.svg)
function listPaymentTerms(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20026|error
Returns a list of paymentTerms
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20026|error - (v1.0) Succesfully returned a list of paymentTerms
postPaymentTerm![](/images/permalink.svg)
function postPaymentTerm(string companyId, string contentType, json payload) returns PaymentTerm|error
Creates an object of type paymentTerm in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- PaymentTerm|error - (v1.0) A new paymentTerm has been succesfully created
getPaymentTerm![](/images/permalink.svg)
function getPaymentTerm(string companyId, string paymenttermId, string[]? 'select) returns PaymentTerm|error
Retrieve the properties and relationships of an object of type paymentTerm for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- paymenttermId string - (v1.0) id for paymentTerm
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PaymentTerm|error - (v1.0) Succesfully returned the requested paymentTerm
deletePaymentTerm![](/images/permalink.svg)
Deletes an object of type paymentTerm in Dynamics 365 Business Central
patchPaymentTerm![](/images/permalink.svg)
function patchPaymentTerm(string companyId, string paymenttermId, string contentType, string ifMatch, json payload) returns PaymentTerm|error
Updates an object of type paymentTerm in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- paymenttermId string - (v1.0) id for paymentTerm
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- PaymentTerm|error - (v1.0) Succesfully updated the specifiedpaymentTerm
listShipmentMethods![](/images/permalink.svg)
function listShipmentMethods(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20027|error
Returns a list of shipmentMethods
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20027|error - (v1.0) Succesfully returned a list of shipmentMethods
postShipmentMethod![](/images/permalink.svg)
function postShipmentMethod(string companyId, string contentType, json payload) returns ShipmentMethod|error
Creates an object of type shipmentMethod in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- ShipmentMethod|error - (v1.0) A new shipmentMethod has been succesfully created
getShipmentMethod![](/images/permalink.svg)
function getShipmentMethod(string companyId, string shipmentmethodId, string[]? 'select) returns ShipmentMethod|error
Retrieve the properties and relationships of an object of type shipmentMethod for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- shipmentmethodId string - (v1.0) id for shipmentMethod
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- ShipmentMethod|error - (v1.0) Succesfully returned the requested shipmentMethod
deleteShipmentMethod![](/images/permalink.svg)
Deletes an object of type shipmentMethod in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- shipmentmethodId string - (v1.0) id for shipmentMethod
patchShipmentMethod![](/images/permalink.svg)
function patchShipmentMethod(string companyId, string shipmentmethodId, string contentType, string ifMatch, json payload) returns ShipmentMethod|error
Updates an object of type shipmentMethod in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- shipmentmethodId string - (v1.0) id for shipmentMethod
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- ShipmentMethod|error - (v1.0) Succesfully updated the specifiedshipmentMethod
listItemCategories![](/images/permalink.svg)
function listItemCategories(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20028|error
Returns a list of itemCategories
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20028|error - (v1.0) Succesfully returned a list of itemCategories
postItemCategory![](/images/permalink.svg)
function postItemCategory(string companyId, string contentType, json payload) returns ItemCategory|error
Creates an object of type itemCategory in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- ItemCategory|error - (v1.0) A new itemCategory has been succesfully created
getItemCategory![](/images/permalink.svg)
function getItemCategory(string companyId, string itemcategoryId, string[]? 'select) returns ItemCategory|error
Retrieve the properties and relationships of an object of type itemCategory for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- itemcategoryId string - (v1.0) id for itemCategory
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- ItemCategory|error - (v1.0) Succesfully returned the requested itemCategory
deleteItemCategory![](/images/permalink.svg)
Deletes an object of type itemCategory in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemcategoryId string - (v1.0) id for itemCategory
patchItemCategory![](/images/permalink.svg)
function patchItemCategory(string companyId, string itemcategoryId, string contentType, string ifMatch, json payload) returns ItemCategory|error
Updates an object of type itemCategory in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- itemcategoryId string - (v1.0) id for itemCategory
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- ItemCategory|error - (v1.0) Succesfully updated the specifieditemCategory
listCashFlowStatement![](/images/permalink.svg)
function listCashFlowStatement(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20029|error
Returns a list of cashFlowStatement
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20029|error - (v1.0) Succesfully returned a list of cashFlowStatement
getCashFlowStatement![](/images/permalink.svg)
function getCashFlowStatement(string companyId, int cashflowstatementLinenumber, string[]? 'select) returns CashFlowStatement|error
Retrieve the properties and relationships of an object of type cashFlowStatement for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- cashflowstatementLinenumber int - (v1.0) lineNumber for cashFlowStatement
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CashFlowStatement|error - (v1.0) Succesfully returned the requested cashFlowStatement
listCountriesRegions![](/images/permalink.svg)
function listCountriesRegions(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20030|error
Returns a list of countriesRegions
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20030|error - (v1.0) Succesfully returned a list of countriesRegions
postCountryRegion![](/images/permalink.svg)
function postCountryRegion(string companyId, string contentType, json payload) returns CountryRegion|error
Creates an object of type countryRegion in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- CountryRegion|error - (v1.0) A new countryRegion has been succesfully created
getCountryRegion![](/images/permalink.svg)
function getCountryRegion(string companyId, string countryregionId, string[]? 'select) returns CountryRegion|error
Retrieve the properties and relationships of an object of type countryRegion for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- countryregionId string - (v1.0) id for countryRegion
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CountryRegion|error - (v1.0) Succesfully returned the requested countryRegion
deleteCountryRegion![](/images/permalink.svg)
Deletes an object of type countryRegion in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- countryregionId string - (v1.0) id for countryRegion
patchCountryRegion![](/images/permalink.svg)
function patchCountryRegion(string companyId, string countryregionId, string contentType, string ifMatch, json payload) returns CountryRegion|error
Updates an object of type countryRegion in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- countryregionId string - (v1.0) id for countryRegion
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- CountryRegion|error - (v1.0) Succesfully updated the specifiedcountryRegion
listSalesOrders![](/images/permalink.svg)
function listSalesOrders(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20031|error
Returns a list of salesOrders
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20031|error - (v1.0) Succesfully returned a list of salesOrders
postSalesOrder![](/images/permalink.svg)
function postSalesOrder(string companyId, string contentType, json payload) returns SalesOrder|error
Creates an object of type salesOrder in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesOrder|error - (v1.0) A new salesOrder has been succesfully created
getSalesOrder![](/images/permalink.svg)
function getSalesOrder(string companyId, string salesorderId, string[]? expand, string[]? 'select) returns SalesOrder|error
Retrieve the properties and relationships of an object of type salesOrder for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesorderId string - (v1.0) id for salesOrder
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesOrder|error - (v1.0) Succesfully returned the requested salesOrder
deleteSalesOrder![](/images/permalink.svg)
Deletes an object of type salesOrder in Dynamics 365 Business Central
patchSalesOrder![](/images/permalink.svg)
function patchSalesOrder(string companyId, string salesorderId, string contentType, string ifMatch, json payload) returns SalesOrder|error
Updates an object of type salesOrder in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesorderId string - (v1.0) id for salesOrder
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesOrder|error - (v1.0) Succesfully updated the specifiedsalesOrder
shipAndInvoiceActionSalesOrders![](/images/permalink.svg)
function shipAndInvoiceActionSalesOrders(string companyId, string salesorderId) returns Response|error
Performs the shipAndInvoice action for salesOrders entity
Return Type
listSalesOrderLinesForSalesOrder![](/images/permalink.svg)
function listSalesOrderLinesForSalesOrder(string companyId, string salesorderId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20032|error
Returns a list of salesOrderLines
Parameters
- companyId string - (v1.0) id for company
- salesorderId string - (v1.0) id for salesOrder
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20032|error - (v1.0) Succesfully returned a list of salesOrderLines
postSalesOrderLineForSalesOrder![](/images/permalink.svg)
function postSalesOrderLineForSalesOrder(string companyId, string salesorderId, string contentType, json payload) returns SalesOrderLine|error
Creates an object of type salesOrderLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesorderId string - (v1.0) id for salesOrder
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesOrderLine|error - (v1.0) A new salesOrderLine has been succesfully created
getSalesOrderLineForSalesOrder![](/images/permalink.svg)
function getSalesOrderLineForSalesOrder(string companyId, string salesorderId, string salesorderlineId, string[]? expand, string[]? 'select) returns SalesOrderLine|error
Retrieve the properties and relationships of an object of type salesOrderLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesorderId string - (v1.0) id for salesOrder
- salesorderlineId string - (v1.0) id for salesOrderLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesOrderLine|error - (v1.0) Succesfully returned the requested salesOrderLine
deleteSalesOrderLineForSalesOrder![](/images/permalink.svg)
function deleteSalesOrderLineForSalesOrder(string companyId, string salesorderId, string salesorderlineId) returns Response|error
Deletes an object of type salesOrderLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesorderId string - (v1.0) id for salesOrder
- salesorderlineId string - (v1.0) id for salesOrderLine
patchSalesOrderLineForSalesOrder![](/images/permalink.svg)
function patchSalesOrderLineForSalesOrder(string companyId, string salesorderId, string salesorderlineId, string contentType, string ifMatch, json payload) returns SalesOrderLine|error
Updates an object of type salesOrderLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesorderId string - (v1.0) id for salesOrder
- salesorderlineId string - (v1.0) id for salesOrderLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesOrderLine|error - (v1.0) Succesfully updated the specifiedsalesOrderLine
listSalesOrderLines![](/images/permalink.svg)
function listSalesOrderLines(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20032|error
Returns a list of salesOrderLines
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20032|error - (v1.0) Succesfully returned a list of salesOrderLines
postSalesOrderLine![](/images/permalink.svg)
function postSalesOrderLine(string companyId, string contentType, json payload) returns SalesOrderLine|error
Creates an object of type salesOrderLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesOrderLine|error - (v1.0) A new salesOrderLine has been succesfully created
getSalesOrderLine![](/images/permalink.svg)
function getSalesOrderLine(string companyId, string salesorderlineId, string[]? expand, string[]? 'select) returns SalesOrderLine|error
Retrieve the properties and relationships of an object of type salesOrderLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesorderlineId string - (v1.0) id for salesOrderLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesOrderLine|error - (v1.0) Succesfully returned the requested salesOrderLine
deleteSalesOrderLine![](/images/permalink.svg)
Deletes an object of type salesOrderLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesorderlineId string - (v1.0) id for salesOrderLine
patchSalesOrderLine![](/images/permalink.svg)
function patchSalesOrderLine(string companyId, string salesorderlineId, string contentType, string ifMatch, json payload) returns SalesOrderLine|error
Updates an object of type salesOrderLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesorderlineId string - (v1.0) id for salesOrderLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesOrderLine|error - (v1.0) Succesfully updated the specifiedsalesOrderLine
listRetainedEarningsStatement![](/images/permalink.svg)
function listRetainedEarningsStatement(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20033|error
Returns a list of retainedEarningsStatement
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20033|error - (v1.0) Succesfully returned a list of retainedEarningsStatement
getRetainedEarningsStatement![](/images/permalink.svg)
function getRetainedEarningsStatement(string companyId, int retainedearningsstatementLinenumber, string[]? 'select) returns RetainedEarningsStatement|error
Retrieve the properties and relationships of an object of type retainedEarningsStatement for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- retainedearningsstatementLinenumber int - (v1.0) lineNumber for retainedEarningsStatement
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- RetainedEarningsStatement|error - (v1.0) Succesfully returned the requested retainedEarningsStatement
listUnitsOfMeasure![](/images/permalink.svg)
function listUnitsOfMeasure(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20034|error
Returns a list of unitsOfMeasure
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20034|error - (v1.0) Succesfully returned a list of unitsOfMeasure
postUnitOfMeasure![](/images/permalink.svg)
function postUnitOfMeasure(string companyId, string contentType, json payload) returns UnitOfMeasure|error
Creates an object of type unitOfMeasure in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- UnitOfMeasure|error - (v1.0) A new unitOfMeasure has been succesfully created
getUnitOfMeasure![](/images/permalink.svg)
function getUnitOfMeasure(string companyId, string unitofmeasureId, string[]? 'select) returns UnitOfMeasure|error
Retrieve the properties and relationships of an object of type unitOfMeasure for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- unitofmeasureId string - (v1.0) id for unitOfMeasure
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- UnitOfMeasure|error - (v1.0) Succesfully returned the requested unitOfMeasure
deleteUnitOfMeasure![](/images/permalink.svg)
Deletes an object of type unitOfMeasure in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- unitofmeasureId string - (v1.0) id for unitOfMeasure
patchUnitOfMeasure![](/images/permalink.svg)
function patchUnitOfMeasure(string companyId, string unitofmeasureId, string contentType, string ifMatch, json payload) returns UnitOfMeasure|error
Updates an object of type unitOfMeasure in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- unitofmeasureId string - (v1.0) id for unitOfMeasure
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- UnitOfMeasure|error - (v1.0) Succesfully updated the specifiedunitOfMeasure
listAgedAccountsReceivable![](/images/permalink.svg)
function listAgedAccountsReceivable(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20035|error
Returns a list of agedAccountsReceivable
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20035|error - (v1.0) Succesfully returned a list of agedAccountsReceivable
getAgedAccountsReceivable![](/images/permalink.svg)
function getAgedAccountsReceivable(string companyId, string agedaccountsreceivableCustomerid, string[]? 'select) returns AgedAccountsReceivable|error
Retrieve the properties and relationships of an object of type agedAccountsReceivable for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- agedaccountsreceivableCustomerid string - (v1.0) customerId for agedAccountsReceivable
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- AgedAccountsReceivable|error - (v1.0) Succesfully returned the requested agedAccountsReceivable
listAgedAccountsPayable![](/images/permalink.svg)
function listAgedAccountsPayable(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20036|error
Returns a list of agedAccountsPayable
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20036|error - (v1.0) Succesfully returned a list of agedAccountsPayable
getAgedAccountsPayable![](/images/permalink.svg)
function getAgedAccountsPayable(string companyId, string agedaccountspayableVendorid, string[]? 'select) returns AgedAccountsPayable|error
Retrieve the properties and relationships of an object of type agedAccountsPayable for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- agedaccountspayableVendorid string - (v1.0) vendorId for agedAccountsPayable
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- AgedAccountsPayable|error - (v1.0) Succesfully returned the requested agedAccountsPayable
listBalanceSheet![](/images/permalink.svg)
function listBalanceSheet(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20037|error
Returns a list of balanceSheet
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20037|error - (v1.0) Succesfully returned a list of balanceSheet
getBalanceSheet![](/images/permalink.svg)
function getBalanceSheet(string companyId, int balancesheetLinenumber, string[]? 'select) returns BalanceSheet|error
Retrieve the properties and relationships of an object of type balanceSheet for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- balancesheetLinenumber int - (v1.0) lineNumber for balanceSheet
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- BalanceSheet|error - (v1.0) Succesfully returned the requested balanceSheet
listTrialBalance![](/images/permalink.svg)
function listTrialBalance(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20038|error
Returns a list of trialBalance
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20038|error - (v1.0) Succesfully returned a list of trialBalance
getTrialBalance![](/images/permalink.svg)
function getTrialBalance(string companyId, string trialbalanceNumber, string[]? expand, string[]? 'select) returns TrialBalance|error
Retrieve the properties and relationships of an object of type trialBalance for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- trialbalanceNumber string - (v1.0) number for trialBalance
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- TrialBalance|error - (v1.0) Succesfully returned the requested trialBalance
listIncomeStatement![](/images/permalink.svg)
function listIncomeStatement(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20039|error
Returns a list of incomeStatement
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20039|error - (v1.0) Succesfully returned a list of incomeStatement
getIncomeStatement![](/images/permalink.svg)
function getIncomeStatement(string companyId, int incomestatementLinenumber, string[]? 'select) returns IncomeStatement|error
Retrieve the properties and relationships of an object of type incomeStatement for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- incomestatementLinenumber int - (v1.0) lineNumber for incomeStatement
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- IncomeStatement|error - (v1.0) Succesfully returned the requested incomeStatement
listTaxAreas![](/images/permalink.svg)
function listTaxAreas(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20040|error
Returns a list of taxAreas
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20040|error - (v1.0) Succesfully returned a list of taxAreas
postTaxArea![](/images/permalink.svg)
Creates an object of type taxArea in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getTaxArea![](/images/permalink.svg)
Retrieve the properties and relationships of an object of type taxArea for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- taxareaId string - (v1.0) id for taxArea
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteTaxArea![](/images/permalink.svg)
Deletes an object of type taxArea in Dynamics 365 Business Central
patchTaxArea![](/images/permalink.svg)
function patchTaxArea(string companyId, string taxareaId, string contentType, string ifMatch, json payload) returns TaxArea|error
Updates an object of type taxArea in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- taxareaId string - (v1.0) id for taxArea
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listSalesQuotes![](/images/permalink.svg)
function listSalesQuotes(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20041|error
Returns a list of salesQuotes
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20041|error - (v1.0) Succesfully returned a list of salesQuotes
postSalesQuote![](/images/permalink.svg)
function postSalesQuote(string companyId, string contentType, json payload) returns SalesQuote|error
Creates an object of type salesQuote in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesQuote|error - (v1.0) A new salesQuote has been succesfully created
getSalesQuote![](/images/permalink.svg)
function getSalesQuote(string companyId, string salesquoteId, string[]? expand, string[]? 'select) returns SalesQuote|error
Retrieve the properties and relationships of an object of type salesQuote for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesQuote|error - (v1.0) Succesfully returned the requested salesQuote
deleteSalesQuote![](/images/permalink.svg)
Deletes an object of type salesQuote in Dynamics 365 Business Central
patchSalesQuote![](/images/permalink.svg)
function patchSalesQuote(string companyId, string salesquoteId, string contentType, string ifMatch, json payload) returns SalesQuote|error
Updates an object of type salesQuote in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesQuote|error - (v1.0) Succesfully updated the specifiedsalesQuote
makeInvoiceActionSalesQuotes![](/images/permalink.svg)
Performs the makeInvoice action for salesQuotes entity
Return Type
makeOrderActionSalesQuotes![](/images/permalink.svg)
Performs the makeOrder action for salesQuotes entity
Return Type
sendActionSalesQuotes![](/images/permalink.svg)
Performs the send action for salesQuotes entity
Return Type
listSalesQuoteLinesForSalesQuote![](/images/permalink.svg)
function listSalesQuoteLinesForSalesQuote(string companyId, string salesquoteId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20042|error
Returns a list of salesQuoteLines
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20042|error - (v1.0) Succesfully returned a list of salesQuoteLines
postSalesQuoteLineForSalesQuote![](/images/permalink.svg)
function postSalesQuoteLineForSalesQuote(string companyId, string salesquoteId, string contentType, json payload) returns SalesQuoteLine|error
Creates an object of type salesQuoteLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesQuoteLine|error - (v1.0) A new salesQuoteLine has been succesfully created
getSalesQuoteLineForSalesQuote![](/images/permalink.svg)
function getSalesQuoteLineForSalesQuote(string companyId, string salesquoteId, string salesquotelineId, string[]? expand, string[]? 'select) returns SalesQuoteLine|error
Retrieve the properties and relationships of an object of type salesQuoteLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- salesquotelineId string - (v1.0) id for salesQuoteLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesQuoteLine|error - (v1.0) Succesfully returned the requested salesQuoteLine
deleteSalesQuoteLineForSalesQuote![](/images/permalink.svg)
function deleteSalesQuoteLineForSalesQuote(string companyId, string salesquoteId, string salesquotelineId) returns Response|error
Deletes an object of type salesQuoteLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- salesquotelineId string - (v1.0) id for salesQuoteLine
patchSalesQuoteLineForSalesQuote![](/images/permalink.svg)
function patchSalesQuoteLineForSalesQuote(string companyId, string salesquoteId, string salesquotelineId, string contentType, string ifMatch, json payload) returns SalesQuoteLine|error
Updates an object of type salesQuoteLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- salesquotelineId string - (v1.0) id for salesQuoteLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesQuoteLine|error - (v1.0) Succesfully updated the specifiedsalesQuoteLine
listPdfDocumentForSalesQuote![](/images/permalink.svg)
function listPdfDocumentForSalesQuote(string companyId, string salesquoteId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20010|error
Returns a list of pdfDocument
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20010|error - (v1.0) Succesfully returned a list of pdfDocument
getPdfDocumentForSalesQuote![](/images/permalink.svg)
function getPdfDocumentForSalesQuote(string companyId, string salesquoteId, string pdfdocumentId, string[]? 'select) returns PdfDocument|error
Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesquoteId string - (v1.0) id for salesQuote
- pdfdocumentId string - (v1.0) id for pdfDocument
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PdfDocument|error - (v1.0) Succesfully returned the requested pdfDocument
listSalesQuoteLines![](/images/permalink.svg)
function listSalesQuoteLines(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20042|error
Returns a list of salesQuoteLines
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20042|error - (v1.0) Succesfully returned a list of salesQuoteLines
postSalesQuoteLine![](/images/permalink.svg)
function postSalesQuoteLine(string companyId, string contentType, json payload) returns SalesQuoteLine|error
Creates an object of type salesQuoteLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesQuoteLine|error - (v1.0) A new salesQuoteLine has been succesfully created
getSalesQuoteLine![](/images/permalink.svg)
function getSalesQuoteLine(string companyId, string salesquotelineId, string[]? expand, string[]? 'select) returns SalesQuoteLine|error
Retrieve the properties and relationships of an object of type salesQuoteLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salesquotelineId string - (v1.0) id for salesQuoteLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesQuoteLine|error - (v1.0) Succesfully returned the requested salesQuoteLine
deleteSalesQuoteLine![](/images/permalink.svg)
Deletes an object of type salesQuoteLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesquotelineId string - (v1.0) id for salesQuoteLine
patchSalesQuoteLine![](/images/permalink.svg)
function patchSalesQuoteLine(string companyId, string salesquotelineId, string contentType, string ifMatch, json payload) returns SalesQuoteLine|error
Updates an object of type salesQuoteLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salesquotelineId string - (v1.0) id for salesQuoteLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesQuoteLine|error - (v1.0) Succesfully updated the specifiedsalesQuoteLine
listSalesCreditMemos![](/images/permalink.svg)
function listSalesCreditMemos(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20043|error
Returns a list of salesCreditMemos
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20043|error - (v1.0) Succesfully returned a list of salesCreditMemos
postSalesCreditMemo![](/images/permalink.svg)
function postSalesCreditMemo(string companyId, string contentType, json payload) returns SalesCreditMemo|error
Creates an object of type salesCreditMemo in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesCreditMemo|error - (v1.0) A new salesCreditMemo has been succesfully created
getSalesCreditMemo![](/images/permalink.svg)
function getSalesCreditMemo(string companyId, string salescreditmemoId, string[]? expand, string[]? 'select) returns SalesCreditMemo|error
Retrieve the properties and relationships of an object of type salesCreditMemo for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesCreditMemo|error - (v1.0) Succesfully returned the requested salesCreditMemo
deleteSalesCreditMemo![](/images/permalink.svg)
Deletes an object of type salesCreditMemo in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
patchSalesCreditMemo![](/images/permalink.svg)
function patchSalesCreditMemo(string companyId, string salescreditmemoId, string contentType, string ifMatch, json payload) returns SalesCreditMemo|error
Updates an object of type salesCreditMemo in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesCreditMemo|error - (v1.0) Succesfully updated the specifiedsalesCreditMemo
cancelAndSendActionSalesCreditMemos![](/images/permalink.svg)
function cancelAndSendActionSalesCreditMemos(string companyId, string salescreditmemoId) returns Response|error
Performs the cancelAndSend action for salesCreditMemos entity
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
Return Type
cancelActionSalesCreditMemos![](/images/permalink.svg)
function cancelActionSalesCreditMemos(string companyId, string salescreditmemoId) returns Response|error
Performs the cancel action for salesCreditMemos entity
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
Return Type
postAndSendActionSalesCreditMemos![](/images/permalink.svg)
function postAndSendActionSalesCreditMemos(string companyId, string salescreditmemoId) returns Response|error
Performs the postAndSend action for salesCreditMemos entity
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
Return Type
postActionSalesCreditMemos![](/images/permalink.svg)
function postActionSalesCreditMemos(string companyId, string salescreditmemoId) returns Response|error
Performs the post action for salesCreditMemos entity
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
Return Type
sendActionSalesCreditMemos![](/images/permalink.svg)
function sendActionSalesCreditMemos(string companyId, string salescreditmemoId) returns Response|error
Performs the send action for salesCreditMemos entity
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
Return Type
listSalesCreditMemoLinesForSalesCreditMemo![](/images/permalink.svg)
function listSalesCreditMemoLinesForSalesCreditMemo(string companyId, string salescreditmemoId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20044|error
Returns a list of salesCreditMemoLines
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20044|error - (v1.0) Succesfully returned a list of salesCreditMemoLines
postSalesCreditMemoLineForSalesCreditMemo![](/images/permalink.svg)
function postSalesCreditMemoLineForSalesCreditMemo(string companyId, string salescreditmemoId, string contentType, json payload) returns SalesCreditMemoLine|error
Creates an object of type salesCreditMemoLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesCreditMemoLine|error - (v1.0) A new salesCreditMemoLine has been succesfully created
getSalesCreditMemoLineForSalesCreditMemo![](/images/permalink.svg)
function getSalesCreditMemoLineForSalesCreditMemo(string companyId, string salescreditmemoId, string salescreditmemolineId, string[]? expand, string[]? 'select) returns SalesCreditMemoLine|error
Retrieve the properties and relationships of an object of type salesCreditMemoLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- salescreditmemolineId string - (v1.0) id for salesCreditMemoLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesCreditMemoLine|error - (v1.0) Succesfully returned the requested salesCreditMemoLine
deleteSalesCreditMemoLineForSalesCreditMemo![](/images/permalink.svg)
function deleteSalesCreditMemoLineForSalesCreditMemo(string companyId, string salescreditmemoId, string salescreditmemolineId) returns Response|error
Deletes an object of type salesCreditMemoLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- salescreditmemolineId string - (v1.0) id for salesCreditMemoLine
patchSalesCreditMemoLineForSalesCreditMemo![](/images/permalink.svg)
function patchSalesCreditMemoLineForSalesCreditMemo(string companyId, string salescreditmemoId, string salescreditmemolineId, string contentType, string ifMatch, json payload) returns SalesCreditMemoLine|error
Updates an object of type salesCreditMemoLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- salescreditmemolineId string - (v1.0) id for salesCreditMemoLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesCreditMemoLine|error - (v1.0) Succesfully updated the specifiedsalesCreditMemoLine
listPdfDocumentForSalesCreditMemo![](/images/permalink.svg)
function listPdfDocumentForSalesCreditMemo(string companyId, string salescreditmemoId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20010|error
Returns a list of pdfDocument
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20010|error - (v1.0) Succesfully returned a list of pdfDocument
getPdfDocumentForSalesCreditMemo![](/images/permalink.svg)
function getPdfDocumentForSalesCreditMemo(string companyId, string salescreditmemoId, string pdfdocumentId, string[]? 'select) returns PdfDocument|error
Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salescreditmemoId string - (v1.0) id for salesCreditMemo
- pdfdocumentId string - (v1.0) id for pdfDocument
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PdfDocument|error - (v1.0) Succesfully returned the requested pdfDocument
listSalesCreditMemoLines![](/images/permalink.svg)
function listSalesCreditMemoLines(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20044|error
Returns a list of salesCreditMemoLines
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20044|error - (v1.0) Succesfully returned a list of salesCreditMemoLines
postSalesCreditMemoLine![](/images/permalink.svg)
function postSalesCreditMemoLine(string companyId, string contentType, json payload) returns SalesCreditMemoLine|error
Creates an object of type salesCreditMemoLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- SalesCreditMemoLine|error - (v1.0) A new salesCreditMemoLine has been succesfully created
getSalesCreditMemoLine![](/images/permalink.svg)
function getSalesCreditMemoLine(string companyId, string salescreditmemolineId, string[]? expand, string[]? 'select) returns SalesCreditMemoLine|error
Retrieve the properties and relationships of an object of type salesCreditMemoLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- salescreditmemolineId string - (v1.0) id for salesCreditMemoLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- SalesCreditMemoLine|error - (v1.0) Succesfully returned the requested salesCreditMemoLine
deleteSalesCreditMemoLine![](/images/permalink.svg)
function deleteSalesCreditMemoLine(string companyId, string salescreditmemolineId) returns Response|error
Deletes an object of type salesCreditMemoLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salescreditmemolineId string - (v1.0) id for salesCreditMemoLine
patchSalesCreditMemoLine![](/images/permalink.svg)
function patchSalesCreditMemoLine(string companyId, string salescreditmemolineId, string contentType, string ifMatch, json payload) returns SalesCreditMemoLine|error
Updates an object of type salesCreditMemoLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- salescreditmemolineId string - (v1.0) id for salesCreditMemoLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- SalesCreditMemoLine|error - (v1.0) Succesfully updated the specifiedsalesCreditMemoLine
listGeneralLedgerEntryAttachments![](/images/permalink.svg)
function listGeneralLedgerEntryAttachments(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20045|error
Returns a list of generalLedgerEntryAttachments
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20045|error - (v1.0) Succesfully returned a list of generalLedgerEntryAttachments
postGeneralLedgerEntryAttachments![](/images/permalink.svg)
function postGeneralLedgerEntryAttachments(string companyId, string contentType, json payload) returns GeneralLedgerEntryAttachments|error
Creates an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- GeneralLedgerEntryAttachments|error - (v1.0) A new generalLedgerEntryAttachments has been succesfully created
getGeneralLedgerEntryAttachments![](/images/permalink.svg)
function getGeneralLedgerEntryAttachments(string companyId, int generalledgerentryattachmentsGeneralledgerentrynumber, string generalledgerentryattachmentsId, string[]? expand, string[]? 'select) returns GeneralLedgerEntryAttachments|error
Retrieve the properties and relationships of an object of type generalLedgerEntryAttachments for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- generalledgerentryattachmentsGeneralledgerentrynumber int - (v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments
- generalledgerentryattachmentsId string - (v1.0) id for generalLedgerEntryAttachments
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- GeneralLedgerEntryAttachments|error - (v1.0) Succesfully returned the requested generalLedgerEntryAttachments
deleteGeneralLedgerEntryAttachments![](/images/permalink.svg)
function deleteGeneralLedgerEntryAttachments(string companyId, int generalledgerentryattachmentsGeneralledgerentrynumber, string generalledgerentryattachmentsId) returns Response|error
Deletes an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- generalledgerentryattachmentsGeneralledgerentrynumber int - (v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments
- generalledgerentryattachmentsId string - (v1.0) id for generalLedgerEntryAttachments
patchGeneralLedgerEntryAttachments![](/images/permalink.svg)
function patchGeneralLedgerEntryAttachments(string companyId, int generalledgerentryattachmentsGeneralledgerentrynumber, string generalledgerentryattachmentsId, string contentType, string ifMatch, json payload) returns GeneralLedgerEntryAttachments|error
Updates an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- generalledgerentryattachmentsGeneralledgerentrynumber int - (v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments
- generalledgerentryattachmentsId string - (v1.0) id for generalLedgerEntryAttachments
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- GeneralLedgerEntryAttachments|error - (v1.0) Succesfully updated the specifiedgeneralLedgerEntryAttachments
listPurchaseInvoices![](/images/permalink.svg)
function listPurchaseInvoices(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20046|error
Returns a list of purchaseInvoices
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20046|error - (v1.0) Succesfully returned a list of purchaseInvoices
postPurchaseInvoice![](/images/permalink.svg)
function postPurchaseInvoice(string companyId, string contentType, json payload) returns PurchaseInvoice|error
Creates an object of type purchaseInvoice in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- PurchaseInvoice|error - (v1.0) A new purchaseInvoice has been succesfully created
getPurchaseInvoice![](/images/permalink.svg)
function getPurchaseInvoice(string companyId, string purchaseinvoiceId, string[]? expand, string[]? 'select) returns PurchaseInvoice|error
Retrieve the properties and relationships of an object of type purchaseInvoice for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PurchaseInvoice|error - (v1.0) Succesfully returned the requested purchaseInvoice
deletePurchaseInvoice![](/images/permalink.svg)
Deletes an object of type purchaseInvoice in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
patchPurchaseInvoice![](/images/permalink.svg)
function patchPurchaseInvoice(string companyId, string purchaseinvoiceId, string contentType, string ifMatch, json payload) returns PurchaseInvoice|error
Updates an object of type purchaseInvoice in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- PurchaseInvoice|error - (v1.0) Succesfully updated the specifiedpurchaseInvoice
postActionPurchaseInvoices![](/images/permalink.svg)
function postActionPurchaseInvoices(string companyId, string purchaseinvoiceId) returns Response|error
Performs the post action for purchaseInvoices entity
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
Return Type
listPurchaseInvoiceLinesForPurchaseInvoice![](/images/permalink.svg)
function listPurchaseInvoiceLinesForPurchaseInvoice(string companyId, string purchaseinvoiceId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20047|error
Returns a list of purchaseInvoiceLines
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20047|error - (v1.0) Succesfully returned a list of purchaseInvoiceLines
postPurchaseInvoiceLineForPurchaseInvoice![](/images/permalink.svg)
function postPurchaseInvoiceLineForPurchaseInvoice(string companyId, string purchaseinvoiceId, string contentType, json payload) returns PurchaseInvoiceLine|error
Creates an object of type purchaseInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- contentType string - (v1.0) application/json
- payload json -
Return Type
- PurchaseInvoiceLine|error - (v1.0) A new purchaseInvoiceLine has been succesfully created
getPurchaseInvoiceLineForPurchaseInvoice![](/images/permalink.svg)
function getPurchaseInvoiceLineForPurchaseInvoice(string companyId, string purchaseinvoiceId, string purchaseinvoicelineId, string[]? expand, string[]? 'select) returns PurchaseInvoiceLine|error
Retrieve the properties and relationships of an object of type purchaseInvoiceLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- purchaseinvoicelineId string - (v1.0) id for purchaseInvoiceLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PurchaseInvoiceLine|error - (v1.0) Succesfully returned the requested purchaseInvoiceLine
deletePurchaseInvoiceLineForPurchaseInvoice![](/images/permalink.svg)
function deletePurchaseInvoiceLineForPurchaseInvoice(string companyId, string purchaseinvoiceId, string purchaseinvoicelineId) returns Response|error
Deletes an object of type purchaseInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- purchaseinvoicelineId string - (v1.0) id for purchaseInvoiceLine
patchPurchaseInvoiceLineForPurchaseInvoice![](/images/permalink.svg)
function patchPurchaseInvoiceLineForPurchaseInvoice(string companyId, string purchaseinvoiceId, string purchaseinvoicelineId, string contentType, string ifMatch, json payload) returns PurchaseInvoiceLine|error
Updates an object of type purchaseInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- purchaseinvoicelineId string - (v1.0) id for purchaseInvoiceLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- PurchaseInvoiceLine|error - (v1.0) Succesfully updated the specifiedpurchaseInvoiceLine
listPdfDocumentForPurchaseInvoice![](/images/permalink.svg)
function listPdfDocumentForPurchaseInvoice(string companyId, string purchaseinvoiceId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20010|error
Returns a list of pdfDocument
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20010|error - (v1.0) Succesfully returned a list of pdfDocument
getPdfDocumentForPurchaseInvoice![](/images/permalink.svg)
function getPdfDocumentForPurchaseInvoice(string companyId, string purchaseinvoiceId, string pdfdocumentId, string[]? 'select) returns PdfDocument|error
Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoiceId string - (v1.0) id for purchaseInvoice
- pdfdocumentId string - (v1.0) id for pdfDocument
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PdfDocument|error - (v1.0) Succesfully returned the requested pdfDocument
listPurchaseInvoiceLines![](/images/permalink.svg)
function listPurchaseInvoiceLines(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? expand, string[]? 'select) returns InlineResponse20047|error
Returns a list of purchaseInvoiceLines
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20047|error - (v1.0) Succesfully returned a list of purchaseInvoiceLines
postPurchaseInvoiceLine![](/images/permalink.svg)
function postPurchaseInvoiceLine(string companyId, string contentType, json payload) returns PurchaseInvoiceLine|error
Creates an object of type purchaseInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- PurchaseInvoiceLine|error - (v1.0) A new purchaseInvoiceLine has been succesfully created
getPurchaseInvoiceLine![](/images/permalink.svg)
function getPurchaseInvoiceLine(string companyId, string purchaseinvoicelineId, string[]? expand, string[]? 'select) returns PurchaseInvoiceLine|error
Retrieve the properties and relationships of an object of type purchaseInvoiceLine for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoicelineId string - (v1.0) id for purchaseInvoiceLine
- expand string[]? (default ()) - (v1.0) Entities to expand
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- PurchaseInvoiceLine|error - (v1.0) Succesfully returned the requested purchaseInvoiceLine
deletePurchaseInvoiceLine![](/images/permalink.svg)
function deletePurchaseInvoiceLine(string companyId, string purchaseinvoicelineId) returns Response|error
Deletes an object of type purchaseInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoicelineId string - (v1.0) id for purchaseInvoiceLine
patchPurchaseInvoiceLine![](/images/permalink.svg)
function patchPurchaseInvoiceLine(string companyId, string purchaseinvoicelineId, string contentType, string ifMatch, json payload) returns PurchaseInvoiceLine|error
Updates an object of type purchaseInvoiceLine in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- purchaseinvoicelineId string - (v1.0) id for purchaseInvoiceLine
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- PurchaseInvoiceLine|error - (v1.0) Succesfully updated the specifiedpurchaseInvoiceLine
listProjects![](/images/permalink.svg)
function listProjects(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20048|error
Returns a list of projects
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20048|error - (v1.0) Succesfully returned a list of projects
postProject![](/images/permalink.svg)
Creates an object of type project in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
getProject![](/images/permalink.svg)
Retrieve the properties and relationships of an object of type project for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- projectId string - (v1.0) id for project
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
deleteProject![](/images/permalink.svg)
Deletes an object of type project in Dynamics 365 Business Central
patchProject![](/images/permalink.svg)
function patchProject(string companyId, string projectId, string contentType, string ifMatch, json payload) returns Project|error
Updates an object of type project in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- projectId string - (v1.0) id for project
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
listBankAccounts![](/images/permalink.svg)
function listBankAccounts(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20049|error
Returns a list of bankAccounts
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20049|error - (v1.0) Succesfully returned a list of bankAccounts
postBankAccount![](/images/permalink.svg)
function postBankAccount(string companyId, string contentType, json payload) returns BankAccount|error
Creates an object of type bankAccount in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- contentType string - (v1.0) application/json
- payload json -
Return Type
- BankAccount|error - (v1.0) A new bankAccount has been succesfully created
getBankAccount![](/images/permalink.svg)
function getBankAccount(string companyId, string bankaccountId, string[]? 'select) returns BankAccount|error
Retrieve the properties and relationships of an object of type bankAccount for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- bankaccountId string - (v1.0) id for bankAccount
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- BankAccount|error - (v1.0) Succesfully returned the requested bankAccount
deleteBankAccount![](/images/permalink.svg)
Deletes an object of type bankAccount in Dynamics 365 Business Central
patchBankAccount![](/images/permalink.svg)
function patchBankAccount(string companyId, string bankaccountId, string contentType, string ifMatch, json payload) returns BankAccount|error
Updates an object of type bankAccount in Dynamics 365 Business Central
Parameters
- companyId string - (v1.0) id for company
- bankaccountId string - (v1.0) id for bankAccount
- contentType string - (v1.0) application/json
- ifMatch string - (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
- payload json -
Return Type
- BankAccount|error - (v1.0) Succesfully updated the specifiedbankAccount
listCustomerSales![](/images/permalink.svg)
function listCustomerSales(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20050|error
Returns a list of customerSales
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20050|error - (v1.0) Succesfully returned a list of customerSales
getCustomerSale![](/images/permalink.svg)
function getCustomerSale(string companyId, string customersaleCustomerid, string customersaleCustomernumber, string customersaleName, string[]? 'select) returns CustomerSale|error
Retrieve the properties and relationships of an object of type customerSale for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- customersaleCustomerid string - (v1.0) customerId for customerSale
- customersaleCustomernumber string - (v1.0) customerNumber for customerSale
- customersaleName string - (v1.0) name for customerSale
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- CustomerSale|error - (v1.0) Succesfully returned the requested customerSale
listVendorPurchases![](/images/permalink.svg)
function listVendorPurchases(string companyId, int? top, int? skip, int? 'limit, string? filter, string[]? 'select) returns InlineResponse20051|error
Returns a list of vendorPurchases
Parameters
- companyId string - (v1.0) id for company
- top int? (default ()) - (v1.0) Number of items to return from the top of the list
- skip int? (default ()) - (v1.0) Number of items to skip from the list
- 'limit int? (default ()) - (v1.0) Number of items to return from the list
- filter string? (default ()) - (v1.0) Filtering expression
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- InlineResponse20051|error - (v1.0) Succesfully returned a list of vendorPurchases
getVendorPurchase![](/images/permalink.svg)
function getVendorPurchase(string companyId, string vendorpurchaseVendorid, string vendorpurchaseVendornumber, string vendorpurchaseName, string[]? 'select) returns VendorPurchase|error
Retrieve the properties and relationships of an object of type vendorPurchase for Dynamics 365 Business Central.
Parameters
- companyId string - (v1.0) id for company
- vendorpurchaseVendorid string - (v1.0) vendorId for vendorPurchase
- vendorpurchaseVendornumber string - (v1.0) vendorNumber for vendorPurchase
- vendorpurchaseName string - (v1.0) name for vendorPurchase
- 'select string[]? (default ()) - (v1.0) Selected properties to be retrieved
Return Type
- VendorPurchase|error - (v1.0) Succesfully returned the requested vendorPurchase
Records![](/images/permalink.svg)
microsoft.dynamics365businesscentral: Account![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central account entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central account entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central account entity
- category string? - (v1.0) The category property for the Dynamics 365 Business Central account entity
- subCategory string? - (v1.0) The subCategory property for the Dynamics 365 Business Central account entity
- blocked boolean? - (v1.0) The blocked property for the Dynamics 365 Business Central account entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central account entity
microsoft.dynamics365businesscentral: AgedAccountsPayable![](/images/permalink.svg)
Fields
- vendorId string? - (v1.0) The vendorId property for the Dynamics 365 Business Central agedAccountsPayable entity
- vendorNumber string? - (v1.0) The vendorNumber property for the Dynamics 365 Business Central agedAccountsPayable entity
- name string? - (v1.0) The name property for the Dynamics 365 Business Central agedAccountsPayable entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central agedAccountsPayable entity
- balanceDue decimal? - (v1.0) The balanceDue property for the Dynamics 365 Business Central agedAccountsPayable entity
- currentAmount decimal? - (v1.0) The currentAmount property for the Dynamics 365 Business Central agedAccountsPayable entity
- period1Amount decimal? - (v1.0) The period1Amount property for the Dynamics 365 Business Central agedAccountsPayable entity
- period2Amount decimal? - (v1.0) The period2Amount property for the Dynamics 365 Business Central agedAccountsPayable entity
- period3Amount decimal? - (v1.0) The period3Amount property for the Dynamics 365 Business Central agedAccountsPayable entity
- agedAsOfDate string? - (v1.0) The agedAsOfDate property for the Dynamics 365 Business Central agedAccountsPayable entity
- periodLengthFilter string? - (v1.0) The periodLengthFilter property for the Dynamics 365 Business Central agedAccountsPayable entity
microsoft.dynamics365businesscentral: AgedAccountsReceivable![](/images/permalink.svg)
Fields
- customerId string? - (v1.0) The customerId property for the Dynamics 365 Business Central agedAccountsReceivable entity
- customerNumber string? - (v1.0) The customerNumber property for the Dynamics 365 Business Central agedAccountsReceivable entity
- name string? - (v1.0) The name property for the Dynamics 365 Business Central agedAccountsReceivable entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central agedAccountsReceivable entity
- balanceDue decimal? - (v1.0) The balanceDue property for the Dynamics 365 Business Central agedAccountsReceivable entity
- currentAmount decimal? - (v1.0) The currentAmount property for the Dynamics 365 Business Central agedAccountsReceivable entity
- period1Amount decimal? - (v1.0) The period1Amount property for the Dynamics 365 Business Central agedAccountsReceivable entity
- period2Amount decimal? - (v1.0) The period2Amount property for the Dynamics 365 Business Central agedAccountsReceivable entity
- period3Amount decimal? - (v1.0) The period3Amount property for the Dynamics 365 Business Central agedAccountsReceivable entity
- agedAsOfDate string? - (v1.0) The agedAsOfDate property for the Dynamics 365 Business Central agedAccountsReceivable entity
- periodLengthFilter string? - (v1.0) The periodLengthFilter property for the Dynamics 365 Business Central agedAccountsReceivable entity
microsoft.dynamics365businesscentral: Attachments![](/images/permalink.svg)
Fields
- parentId string? - (v1.0) The parentId property for the Dynamics 365 Business Central attachments entity
- id string? - (v1.0) The id property for the Dynamics 365 Business Central attachments entity
- fileName string? - (v1.0) The fileName property for the Dynamics 365 Business Central attachments entity
- byteSize int? - (v1.0) The byteSize property for the Dynamics 365 Business Central attachments entity
- content string? - (v1.0) The content property for the Dynamics 365 Business Central attachments entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central attachments entity
microsoft.dynamics365businesscentral: BalanceSheet![](/images/permalink.svg)
Fields
- lineNumber int? - (v1.0) The lineNumber property for the Dynamics 365 Business Central balanceSheet entity
- display string? - (v1.0) The display property for the Dynamics 365 Business Central balanceSheet entity
- balance decimal? - (v1.0) The balance property for the Dynamics 365 Business Central balanceSheet entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central balanceSheet entity
- indentation int? - (v1.0) The indentation property for the Dynamics 365 Business Central balanceSheet entity
- dateFilter string? - (v1.0) The dateFilter property for the Dynamics 365 Business Central balanceSheet entity
microsoft.dynamics365businesscentral: BankAccount![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central bankAccount entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central bankAccount entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central bankAccount entity
microsoft.dynamics365businesscentral: CashFlowStatement![](/images/permalink.svg)
Fields
- lineNumber int? - (v1.0) The lineNumber property for the Dynamics 365 Business Central cashFlowStatement entity
- display string? - (v1.0) The display property for the Dynamics 365 Business Central cashFlowStatement entity
- netChange decimal? - (v1.0) The netChange property for the Dynamics 365 Business Central cashFlowStatement entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central cashFlowStatement entity
- indentation int? - (v1.0) The indentation property for the Dynamics 365 Business Central cashFlowStatement entity
- dateFilter string? - (v1.0) The dateFilter property for the Dynamics 365 Business Central cashFlowStatement entity
microsoft.dynamics365businesscentral: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
microsoft.dynamics365businesscentral: Company![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central company entity
- systemVersion string? - (v1.0) The systemVersion property for the Dynamics 365 Business Central company entity
- name string? - (v1.0) The name property for the Dynamics 365 Business Central company entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central company entity
- businessProfileId string? - (v1.0) The businessProfileId property for the Dynamics 365 Business Central company entity
- items Item[]? -
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- customers Customer[]? -
- customerFinancialDetails CustomerFinancialDetail[]? -
- vendors Vendor[]? -
- companyInformation CompanyInformation[]? -
- salesInvoices SalesInvoice[]? -
- salesInvoiceLines SalesInvoiceLine[]? -
- pdfDocument PdfDocument[]? -
- customerPaymentJournals CustomerPaymentJournal[]? -
- customerPayments CustomerPayment[]? -
- accounts Account[]? -
- taxGroups TaxGroup[]? -
- journals Journal[]? -
- journalLines JournalLine[]? -
- attachments Attachments[]? -
- employees Employee[]? -
- timeRegistrationEntries TimeRegistrationEntry[]? -
- generalLedgerEntries GeneralLedgerEntry[]? -
- currencies Currency[]? -
- paymentMethods PaymentMethod[]? -
- dimensions Dimension[]? -
- dimensionValues DimensionValue[]? -
- dimensionLines DimensionLine[]? -
- paymentTerms PaymentTerm[]? -
- shipmentMethods ShipmentMethod[]? -
- itemCategories ItemCategory[]? -
- cashFlowStatement CashFlowStatement[]? -
- countriesRegions CountryRegion[]? -
- salesOrders SalesOrder[]? -
- salesOrderLines SalesOrderLine[]? -
- retainedEarningsStatement RetainedEarningsStatement[]? -
- unitsOfMeasure UnitOfMeasure[]? -
- agedAccountsReceivable AgedAccountsReceivable[]? -
- agedAccountsPayable AgedAccountsPayable[]? -
- balanceSheet BalanceSheet[]? -
- trialBalance TrialBalance[]? -
- incomeStatement IncomeStatement[]? -
- taxAreas TaxArea[]? -
- salesQuotes SalesQuote[]? -
- salesQuoteLines SalesQuoteLine[]? -
- salesCreditMemos SalesCreditMemo[]? -
- salesCreditMemoLines SalesCreditMemoLine[]? -
- generalLedgerEntryAttachments GeneralLedgerEntryAttachments[]? -
- purchaseInvoices PurchaseInvoice[]? -
- purchaseInvoiceLines PurchaseInvoiceLine[]? -
- projects Project[]? -
- bankAccounts BankAccount[]? -
- customerSales CustomerSale[]? -
- vendorPurchases VendorPurchase[]? -
microsoft.dynamics365businesscentral: CompanyInformation![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central companyInformation entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central companyInformation entity
- address Postaladdresstype? -
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central companyInformation entity
- faxNumber string? - (v1.0) The faxNumber property for the Dynamics 365 Business Central companyInformation entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central companyInformation entity
- website string? - (v1.0) The website property for the Dynamics 365 Business Central companyInformation entity
- taxRegistrationNumber string? - (v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central companyInformation entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central companyInformation entity
- currentFiscalYearStartDate string? - (v1.0) The currentFiscalYearStartDate property for the Dynamics 365 Business Central companyInformation entity
- industry string? - (v1.0) The industry property for the Dynamics 365 Business Central companyInformation entity
- picture string? - (v1.0) The picture property for the Dynamics 365 Business Central companyInformation entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central companyInformation entity
microsoft.dynamics365businesscentral: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
microsoft.dynamics365businesscentral: CountryRegion![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central countryRegion entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central countryRegion entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity
- addressFormat string? - (v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity
microsoft.dynamics365businesscentral: Currency![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central currency entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central currency entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central currency entity
- symbol string? - (v1.0) The symbol property for the Dynamics 365 Business Central currency entity
- amountDecimalPlaces string? - (v1.0) The amountDecimalPlaces property for the Dynamics 365 Business Central currency entity
- amountRoundingPrecision decimal? - (v1.0) The amountRoundingPrecision property for the Dynamics 365 Business Central currency entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central currency entity
microsoft.dynamics365businesscentral: Customer![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central customer entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central customer entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central customer entity
- 'type string? - (v1.0) The type property for the Dynamics 365 Business Central customer entity
- address Postaladdresstype? -
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central customer entity
- website string? - (v1.0) The website property for the Dynamics 365 Business Central customer entity
- taxLiable boolean? - (v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity
- taxAreaId string? - (v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity
- taxAreaDisplayName string? - (v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity
- taxRegistrationNumber string? - (v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity
- currencyId string? - (v1.0) The currencyId property for the Dynamics 365 Business Central customer entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity
- paymentTermsId string? - (v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity
- shipmentMethodId string? - (v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity
- paymentMethodId string? - (v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity
- blocked string? - (v1.0) The blocked property for the Dynamics 365 Business Central customer entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity
- customerFinancialDetails CustomerFinancialDetail[]? -
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- currency Currency? -
- paymentTerm PaymentTerm? -
- shipmentMethod ShipmentMethod? -
- paymentMethod PaymentMethod? -
microsoft.dynamics365businesscentral: CustomerFinancialDetail![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central customerFinancialDetail entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central customerFinancialDetail entity
- balance decimal? - (v1.0) The balance property for the Dynamics 365 Business Central customerFinancialDetail entity
- totalSalesExcludingTax decimal? - (v1.0) The totalSalesExcludingTax property for the Dynamics 365 Business Central customerFinancialDetail entity
- overdueAmount decimal? - (v1.0) The overdueAmount property for the Dynamics 365 Business Central customerFinancialDetail entity
microsoft.dynamics365businesscentral: CustomerPayment![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central customerPayment entity
- journalDisplayName string? - (v1.0) The journalDisplayName property for the Dynamics 365 Business Central customerPayment entity
- lineNumber int? - (v1.0) The lineNumber property for the Dynamics 365 Business Central customerPayment entity
- customerId string? - (v1.0) The customerId property for the Dynamics 365 Business Central customerPayment entity
- customerNumber string? - (v1.0) The customerNumber property for the Dynamics 365 Business Central customerPayment entity
- contactId string? - (v1.0) The contactId property for the Dynamics 365 Business Central customerPayment entity
- postingDate string? - (v1.0) The postingDate property for the Dynamics 365 Business Central customerPayment entity
- documentNumber string? - (v1.0) The documentNumber property for the Dynamics 365 Business Central customerPayment entity
- externalDocumentNumber string? - (v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central customerPayment entity
- amount decimal? - (v1.0) The amount property for the Dynamics 365 Business Central customerPayment entity
- appliesToInvoiceId string? - (v1.0) The appliesToInvoiceId property for the Dynamics 365 Business Central customerPayment entity
- appliesToInvoiceNumber string? - (v1.0) The appliesToInvoiceNumber property for the Dynamics 365 Business Central customerPayment entity
- description string? - (v1.0) The description property for the Dynamics 365 Business Central customerPayment entity
- comment string? - (v1.0) The comment property for the Dynamics 365 Business Central customerPayment entity
- dimensions Dimensiontype[]? -
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPayment entity
- customer Customer? -
microsoft.dynamics365businesscentral: CustomerPaymentJournal![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central customerPaymentJournal entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central customerPaymentJournal entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central customerPaymentJournal entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPaymentJournal entity
- balancingAccountId string? - (v1.0) The balancingAccountId property for the Dynamics 365 Business Central customerPaymentJournal entity
- balancingAccountNumber string? - (v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central customerPaymentJournal entity
- customerPayments CustomerPayment[]? -
- account Account? -
microsoft.dynamics365businesscentral: CustomerSale![](/images/permalink.svg)
Fields
- customerId string? - (v1.0) The customerId property for the Dynamics 365 Business Central customerSale entity
- customerNumber string? - (v1.0) The customerNumber property for the Dynamics 365 Business Central customerSale entity
- name string? - (v1.0) The name property for the Dynamics 365 Business Central customerSale entity
- totalSalesAmount decimal? - (v1.0) The totalSalesAmount property for the Dynamics 365 Business Central customerSale entity
- dateFilter_FilterOnly string? - (v1.0) The dateFilter_FilterOnly property for the Dynamics 365 Business Central customerSale entity
microsoft.dynamics365businesscentral: DefaultDimensions![](/images/permalink.svg)
Fields
- parentId string? - (v1.0) The parentId property for the Dynamics 365 Business Central defaultDimensions entity
- dimensionId string? - (v1.0) The dimensionId property for the Dynamics 365 Business Central defaultDimensions entity
- dimensionCode string? - (v1.0) The dimensionCode property for the Dynamics 365 Business Central defaultDimensions entity
- dimensionValueId string? - (v1.0) The dimensionValueId property for the Dynamics 365 Business Central defaultDimensions entity
- dimensionValueCode string? - (v1.0) The dimensionValueCode property for the Dynamics 365 Business Central defaultDimensions entity
- postingValidation string? - (v1.0) The postingValidation property for the Dynamics 365 Business Central defaultDimensions entity
- account Account? -
- dimension Dimension? -
- dimensionValue DimensionValue? -
microsoft.dynamics365businesscentral: Dimension![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central dimension entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central dimension entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central dimension entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central dimension entity
- dimensionValues DimensionValue[]? -
microsoft.dynamics365businesscentral: DimensionLine![](/images/permalink.svg)
Fields
- parentId string? - (v1.0) The parentId property for the Dynamics 365 Business Central dimensionLine entity
- id string? - (v1.0) The id property for the Dynamics 365 Business Central dimensionLine entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central dimensionLine entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central dimensionLine entity
- valueId string? - (v1.0) The valueId property for the Dynamics 365 Business Central dimensionLine entity
- valueCode string? - (v1.0) The valueCode property for the Dynamics 365 Business Central dimensionLine entity
- valueDisplayName string? - (v1.0) The valueDisplayName property for the Dynamics 365 Business Central dimensionLine entity
- dimension Dimension? -
microsoft.dynamics365businesscentral: Dimensiontype![](/images/permalink.svg)
Fields
- code string? - (v1.0) The code property for the Dynamics 365 Business Central dimensiontype entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central dimensiontype entity
- valueCode string? - (v1.0) The valueCode property for the Dynamics 365 Business Central dimensiontype entity
- valueDisplayName string? - (v1.0) The valueDisplayName property for the Dynamics 365 Business Central dimensiontype entity
- customer Customer? -
microsoft.dynamics365businesscentral: DimensionValue![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central dimensionValue entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central dimensionValue entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central dimensionValue entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central dimensionValue entity
microsoft.dynamics365businesscentral: Documentlineobjectdetailstype![](/images/permalink.svg)
Fields
- number string? - (v1.0) The number property for the Dynamics 365 Business Central documentlineobjectdetailstype entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central documentlineobjectdetailstype entity
- item Item? -
- account Account? -
microsoft.dynamics365businesscentral: Employee![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central employee entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central employee entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central employee entity
- givenName string? - (v1.0) The givenName property for the Dynamics 365 Business Central employee entity
- middleName string? - (v1.0) The middleName property for the Dynamics 365 Business Central employee entity
- surname string? - (v1.0) The surname property for the Dynamics 365 Business Central employee entity
- jobTitle string? - (v1.0) The jobTitle property for the Dynamics 365 Business Central employee entity
- address Postaladdresstype? -
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central employee entity
- mobilePhone string? - (v1.0) The mobilePhone property for the Dynamics 365 Business Central employee entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central employee entity
- personalEmail string? - (v1.0) The personalEmail property for the Dynamics 365 Business Central employee entity
- employmentDate string? - (v1.0) The employmentDate property for the Dynamics 365 Business Central employee entity
- terminationDate string? - (v1.0) The terminationDate property for the Dynamics 365 Business Central employee entity
- status string? - (v1.0) The status property for the Dynamics 365 Business Central employee entity
- birthDate string? - (v1.0) The birthDate property for the Dynamics 365 Business Central employee entity
- statisticsGroupCode string? - (v1.0) The statisticsGroupCode property for the Dynamics 365 Business Central employee entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central employee entity
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- timeRegistrationEntries TimeRegistrationEntry[]? -
microsoft.dynamics365businesscentral: GeneralLedgerEntry![](/images/permalink.svg)
Fields
- id int? - (v1.0) The id property for the Dynamics 365 Business Central generalLedgerEntry entity
- postingDate string? - (v1.0) The postingDate property for the Dynamics 365 Business Central generalLedgerEntry entity
- documentNumber string? - (v1.0) The documentNumber property for the Dynamics 365 Business Central generalLedgerEntry entity
- documentType string? - (v1.0) The documentType property for the Dynamics 365 Business Central generalLedgerEntry entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central generalLedgerEntry entity
- accountNumber string? - (v1.0) The accountNumber property for the Dynamics 365 Business Central generalLedgerEntry entity
- description string? - (v1.0) The description property for the Dynamics 365 Business Central generalLedgerEntry entity
- debitAmount decimal? - (v1.0) The debitAmount property for the Dynamics 365 Business Central generalLedgerEntry entity
- creditAmount decimal? - (v1.0) The creditAmount property for the Dynamics 365 Business Central generalLedgerEntry entity
- dimensions Dimensiontype[]? -
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central generalLedgerEntry entity
- account Account? -
microsoft.dynamics365businesscentral: GeneralLedgerEntryAttachments![](/images/permalink.svg)
Fields
- generalLedgerEntryNumber int? - (v1.0) The generalLedgerEntryNumber property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity
- id string? - (v1.0) The id property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity
- fileName string? - (v1.0) The fileName property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity
- byteSize int? - (v1.0) The byteSize property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity
- content string? - (v1.0) The content property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity
- createdDateTime string? - (v1.0) The createdDateTime property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity
- generalLedgerEntry GeneralLedgerEntry? -
microsoft.dynamics365businesscentral: IncomeStatement![](/images/permalink.svg)
Fields
- lineNumber int? - (v1.0) The lineNumber property for the Dynamics 365 Business Central incomeStatement entity
- display string? - (v1.0) The display property for the Dynamics 365 Business Central incomeStatement entity
- netChange decimal? - (v1.0) The netChange property for the Dynamics 365 Business Central incomeStatement entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central incomeStatement entity
- indentation int? - (v1.0) The indentation property for the Dynamics 365 Business Central incomeStatement entity
- dateFilter string? - (v1.0) The dateFilter property for the Dynamics 365 Business Central incomeStatement entity
microsoft.dynamics365businesscentral: InlineResponse200![](/images/permalink.svg)
Fields
- value Company[]? -
microsoft.dynamics365businesscentral: InlineResponse2001![](/images/permalink.svg)
Fields
- value Item[]? -
microsoft.dynamics365businesscentral: InlineResponse20010![](/images/permalink.svg)
Fields
- value PdfDocument[]? -
microsoft.dynamics365businesscentral: InlineResponse20011![](/images/permalink.svg)
Fields
- value CustomerPaymentJournal[]? -
microsoft.dynamics365businesscentral: InlineResponse20012![](/images/permalink.svg)
Fields
- value CustomerPayment[]? -
microsoft.dynamics365businesscentral: InlineResponse20013![](/images/permalink.svg)
Fields
- value Account[]? -
microsoft.dynamics365businesscentral: InlineResponse20014![](/images/permalink.svg)
Fields
- value TaxGroup[]? -
microsoft.dynamics365businesscentral: InlineResponse20015![](/images/permalink.svg)
Fields
- value Journal[]? -
microsoft.dynamics365businesscentral: InlineResponse20016![](/images/permalink.svg)
Fields
- value JournalLine[]? -
microsoft.dynamics365businesscentral: InlineResponse20017![](/images/permalink.svg)
Fields
- value Attachments[]? -
microsoft.dynamics365businesscentral: InlineResponse20018![](/images/permalink.svg)
Fields
- value Employee[]? -
microsoft.dynamics365businesscentral: InlineResponse20019![](/images/permalink.svg)
Fields
- value TimeRegistrationEntry[]? -
microsoft.dynamics365businesscentral: InlineResponse2002![](/images/permalink.svg)
Fields
- value Picture[]? -
microsoft.dynamics365businesscentral: InlineResponse20020![](/images/permalink.svg)
Fields
- value GeneralLedgerEntry[]? -
microsoft.dynamics365businesscentral: InlineResponse20021![](/images/permalink.svg)
Fields
- value Currency[]? -
microsoft.dynamics365businesscentral: InlineResponse20022![](/images/permalink.svg)
Fields
- value PaymentMethod[]? -
microsoft.dynamics365businesscentral: InlineResponse20023![](/images/permalink.svg)
Fields
- value Dimension[]? -
microsoft.dynamics365businesscentral: InlineResponse20024![](/images/permalink.svg)
Fields
- value DimensionValue[]? -
microsoft.dynamics365businesscentral: InlineResponse20025![](/images/permalink.svg)
Fields
- value DimensionLine[]? -
microsoft.dynamics365businesscentral: InlineResponse20026![](/images/permalink.svg)
Fields
- value PaymentTerm[]? -
microsoft.dynamics365businesscentral: InlineResponse20027![](/images/permalink.svg)
Fields
- value ShipmentMethod[]? -
microsoft.dynamics365businesscentral: InlineResponse20028![](/images/permalink.svg)
Fields
- value ItemCategory[]? -
microsoft.dynamics365businesscentral: InlineResponse20029![](/images/permalink.svg)
Fields
- value CashFlowStatement[]? -
microsoft.dynamics365businesscentral: InlineResponse2003![](/images/permalink.svg)
Fields
- value DefaultDimensions[]? -
microsoft.dynamics365businesscentral: InlineResponse20030![](/images/permalink.svg)
Fields
- value CountryRegion[]? -
microsoft.dynamics365businesscentral: InlineResponse20031![](/images/permalink.svg)
Fields
- value SalesOrder[]? -
microsoft.dynamics365businesscentral: InlineResponse20032![](/images/permalink.svg)
Fields
- value SalesOrderLine[]? -
microsoft.dynamics365businesscentral: InlineResponse20033![](/images/permalink.svg)
Fields
- value RetainedEarningsStatement[]? -
microsoft.dynamics365businesscentral: InlineResponse20034![](/images/permalink.svg)
Fields
- value UnitOfMeasure[]? -
microsoft.dynamics365businesscentral: InlineResponse20035![](/images/permalink.svg)
Fields
- value AgedAccountsReceivable[]? -
microsoft.dynamics365businesscentral: InlineResponse20036![](/images/permalink.svg)
Fields
- value AgedAccountsPayable[]? -
microsoft.dynamics365businesscentral: InlineResponse20037![](/images/permalink.svg)
Fields
- value BalanceSheet[]? -
microsoft.dynamics365businesscentral: InlineResponse20038![](/images/permalink.svg)
Fields
- value TrialBalance[]? -
microsoft.dynamics365businesscentral: InlineResponse20039![](/images/permalink.svg)
Fields
- value IncomeStatement[]? -
microsoft.dynamics365businesscentral: InlineResponse2004![](/images/permalink.svg)
Fields
- value Customer[]? -
microsoft.dynamics365businesscentral: InlineResponse20040![](/images/permalink.svg)
Fields
- value TaxArea[]? -
microsoft.dynamics365businesscentral: InlineResponse20041![](/images/permalink.svg)
Fields
- value SalesQuote[]? -
microsoft.dynamics365businesscentral: InlineResponse20042![](/images/permalink.svg)
Fields
- value SalesQuoteLine[]? -
microsoft.dynamics365businesscentral: InlineResponse20043![](/images/permalink.svg)
Fields
- value SalesCreditMemo[]? -
microsoft.dynamics365businesscentral: InlineResponse20044![](/images/permalink.svg)
Fields
- value SalesCreditMemoLine[]? -
microsoft.dynamics365businesscentral: InlineResponse20045![](/images/permalink.svg)
Fields
- value GeneralLedgerEntryAttachments[]? -
microsoft.dynamics365businesscentral: InlineResponse20046![](/images/permalink.svg)
Fields
- value PurchaseInvoice[]? -
microsoft.dynamics365businesscentral: InlineResponse20047![](/images/permalink.svg)
Fields
- value PurchaseInvoiceLine[]? -
microsoft.dynamics365businesscentral: InlineResponse20048![](/images/permalink.svg)
Fields
- value Project[]? -
microsoft.dynamics365businesscentral: InlineResponse20049![](/images/permalink.svg)
Fields
- value BankAccount[]? -
microsoft.dynamics365businesscentral: InlineResponse2005![](/images/permalink.svg)
Fields
- value CustomerFinancialDetail[]? -
microsoft.dynamics365businesscentral: InlineResponse20050![](/images/permalink.svg)
Fields
- value CustomerSale[]? -
microsoft.dynamics365businesscentral: InlineResponse20051![](/images/permalink.svg)
Fields
- value VendorPurchase[]? -
microsoft.dynamics365businesscentral: InlineResponse2006![](/images/permalink.svg)
Fields
- value Vendor[]? -
microsoft.dynamics365businesscentral: InlineResponse2007![](/images/permalink.svg)
Fields
- value CompanyInformation[]? -
microsoft.dynamics365businesscentral: InlineResponse2008![](/images/permalink.svg)
Fields
- value SalesInvoice[]? -
microsoft.dynamics365businesscentral: InlineResponse2009![](/images/permalink.svg)
Fields
- value SalesInvoiceLine[]? -
microsoft.dynamics365businesscentral: Item![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central item entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central item entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central item entity
- 'type string? - (v1.0) The type property for the Dynamics 365 Business Central item entity
- itemCategoryId string? - (v1.0) The itemCategoryId property for the Dynamics 365 Business Central item entity
- itemCategoryCode string? - (v1.0) The itemCategoryCode property for the Dynamics 365 Business Central item entity
- blocked boolean? - (v1.0) The blocked property for the Dynamics 365 Business Central item entity
- baseUnitOfMeasureId string? - (v1.0) The baseUnitOfMeasureId property for the Dynamics 365 Business Central item entity
- baseUnitOfMeasure Unitofmeasuretype? -
- gtin string? - (v1.0) The gtin property for the Dynamics 365 Business Central item entity
- inventory decimal? - (v1.0) The inventory property for the Dynamics 365 Business Central item entity
- unitPrice decimal? - (v1.0) The unitPrice property for the Dynamics 365 Business Central item entity
- priceIncludesTax boolean? - (v1.0) The priceIncludesTax property for the Dynamics 365 Business Central item entity
- unitCost decimal? - (v1.0) The unitCost property for the Dynamics 365 Business Central item entity
- taxGroupId string? - (v1.0) The taxGroupId property for the Dynamics 365 Business Central item entity
- taxGroupCode string? - (v1.0) The taxGroupCode property for the Dynamics 365 Business Central item entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central item entity
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- itemCategory ItemCategory? -
microsoft.dynamics365businesscentral: ItemCategory![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central itemCategory entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central itemCategory entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central itemCategory entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central itemCategory entity
microsoft.dynamics365businesscentral: Itemunitofmeasureconversiontype![](/images/permalink.svg)
Fields
- toUnitOfMeasure string? - (v1.0) The toUnitOfMeasure property for the Dynamics 365 Business Central itemunitofmeasureconversiontype entity
- fromToConversionRate decimal? - (v1.0) The fromToConversionRate property for the Dynamics 365 Business Central itemunitofmeasureconversiontype entity
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- itemCategory ItemCategory? -
microsoft.dynamics365businesscentral: Journal![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central journal entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central journal entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central journal entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journal entity
- balancingAccountId string? - (v1.0) The balancingAccountId property for the Dynamics 365 Business Central journal entity
- balancingAccountNumber string? - (v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central journal entity
- journalLines JournalLine[]? -
- account Account? -
microsoft.dynamics365businesscentral: JournalLine![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central journalLine entity
- journalDisplayName string? - (v1.0) The journalDisplayName property for the Dynamics 365 Business Central journalLine entity
- lineNumber int? - (v1.0) The lineNumber property for the Dynamics 365 Business Central journalLine entity
- accountType string? - (v1.0) The accountType property for the Dynamics 365 Business Central journalLine entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central journalLine entity
- accountNumber string? - (v1.0) The accountNumber property for the Dynamics 365 Business Central journalLine entity
- postingDate string? - (v1.0) The postingDate property for the Dynamics 365 Business Central journalLine entity
- documentNumber string? - (v1.0) The documentNumber property for the Dynamics 365 Business Central journalLine entity
- externalDocumentNumber string? - (v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central journalLine entity
- amount decimal? - (v1.0) The amount property for the Dynamics 365 Business Central journalLine entity
- description string? - (v1.0) The description property for the Dynamics 365 Business Central journalLine entity
- comment string? - (v1.0) The comment property for the Dynamics 365 Business Central journalLine entity
- dimensions Dimensiontype[]? -
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journalLine entity
- attachments Attachments[]? -
- account Account? -
microsoft.dynamics365businesscentral: PaymentMethod![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central paymentMethod entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central paymentMethod entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central paymentMethod entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central paymentMethod entity
microsoft.dynamics365businesscentral: PaymentTerm![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central paymentTerm entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central paymentTerm entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central paymentTerm entity
- dueDateCalculation string? - (v1.0) The dueDateCalculation property for the Dynamics 365 Business Central paymentTerm entity
- discountDateCalculation string? - (v1.0) The discountDateCalculation property for the Dynamics 365 Business Central paymentTerm entity
- discountPercent decimal? - (v1.0) The discountPercent property for the Dynamics 365 Business Central paymentTerm entity
- calculateDiscountOnCreditMemos boolean? - (v1.0) The calculateDiscountOnCreditMemos property for the Dynamics 365 Business Central paymentTerm entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central paymentTerm entity
microsoft.dynamics365businesscentral: PdfDocument![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central pdfDocument entity
- content string? - (v1.0) The content property for the Dynamics 365 Business Central pdfDocument entity
microsoft.dynamics365businesscentral: Picture![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central picture entity
- width int? - (v1.0) The width property for the Dynamics 365 Business Central picture entity
- height int? - (v1.0) The height property for the Dynamics 365 Business Central picture entity
- contentType string? - (v1.0) The contentType property for the Dynamics 365 Business Central picture entity
- 'content\@odata\.mediaEditLink string? - (v1.0) The content@odata.mediaEditLink property for the Dynamics 365 Business Central picture entity
- 'content\@odata\.mediaReadLink string? - (v1.0) The content@odata.mediaReadLink property for the Dynamics 365 Business Central picture entity
microsoft.dynamics365businesscentral: Postaladdresstype![](/images/permalink.svg)
Fields
- street string? - (v1.0) The street property for the Dynamics 365 Business Central postaladdresstype entity
- city string? - (v1.0) The city property for the Dynamics 365 Business Central postaladdresstype entity
- state string? - (v1.0) The state property for the Dynamics 365 Business Central postaladdresstype entity
- countryLetterCode string? - (v1.0) The countryLetterCode property for the Dynamics 365 Business Central postaladdresstype entity
- postalCode string? - (v1.0) The postalCode property for the Dynamics 365 Business Central postaladdresstype entity
- customerFinancialDetails CustomerFinancialDetail[]? -
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- currency Currency? -
- paymentTerm PaymentTerm? -
- shipmentMethod ShipmentMethod? -
- paymentMethod PaymentMethod? -
microsoft.dynamics365businesscentral: Project![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central project entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central project entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central project entity
microsoft.dynamics365businesscentral: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
microsoft.dynamics365businesscentral: PurchaseInvoice![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central purchaseInvoice entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central purchaseInvoice entity
- invoiceDate string? - (v1.0) The invoiceDate property for the Dynamics 365 Business Central purchaseInvoice entity
- dueDate string? - (v1.0) The dueDate property for the Dynamics 365 Business Central purchaseInvoice entity
- vendorInvoiceNumber string? - (v1.0) The vendorInvoiceNumber property for the Dynamics 365 Business Central purchaseInvoice entity
- vendorId string? - (v1.0) The vendorId property for the Dynamics 365 Business Central purchaseInvoice entity
- vendorNumber string? - (v1.0) The vendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity
- vendorName string? - (v1.0) The vendorName property for the Dynamics 365 Business Central purchaseInvoice entity
- payToName string? - (v1.0) The payToName property for the Dynamics 365 Business Central purchaseInvoice entity
- payToContact string? - (v1.0) The payToContact property for the Dynamics 365 Business Central purchaseInvoice entity
- payToVendorId string? - (v1.0) The payToVendorId property for the Dynamics 365 Business Central purchaseInvoice entity
- payToVendorNumber string? - (v1.0) The payToVendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity
- shipToName string? - (v1.0) The shipToName property for the Dynamics 365 Business Central purchaseInvoice entity
- shipToContact string? - (v1.0) The shipToContact property for the Dynamics 365 Business Central purchaseInvoice entity
- buyFromAddress Postaladdresstype? -
- payToAddress Postaladdresstype? -
- shipToAddress Postaladdresstype? -
- currencyId string? - (v1.0) The currencyId property for the Dynamics 365 Business Central purchaseInvoice entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central purchaseInvoice entity
- pricesIncludeTax boolean? - (v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central purchaseInvoice entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central purchaseInvoice entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central purchaseInvoice entity
- totalAmountExcludingTax decimal? - (v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central purchaseInvoice entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central purchaseInvoice entity
- totalAmountIncludingTax decimal? - (v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central purchaseInvoice entity
- status string? - (v1.0) The status property for the Dynamics 365 Business Central purchaseInvoice entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central purchaseInvoice entity
- purchaseInvoiceLines PurchaseInvoiceLine[]? -
- pdfDocument PdfDocument[]? -
- vendor Vendor? -
- currency Currency? -
microsoft.dynamics365businesscentral: PurchaseInvoiceLine![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- documentId string? - (v1.0) The documentId property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- sequence int? - (v1.0) The sequence property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- itemId string? - (v1.0) The itemId property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- lineDetails Documentlineobjectdetailstype? -
- description string? - (v1.0) The description property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- unitOfMeasure Unitofmeasuretype? -
- unitCost decimal? - (v1.0) The unitCost property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- quantity decimal? - (v1.0) The quantity property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- discountPercent decimal? - (v1.0) The discountPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- amountExcludingTax decimal? - (v1.0) The amountExcludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- taxCode string? - (v1.0) The taxCode property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- taxPercent decimal? - (v1.0) The taxPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- amountIncludingTax decimal? - (v1.0) The amountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- invoiceDiscountAllocation decimal? - (v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- netAmount decimal? - (v1.0) The netAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- netTaxAmount decimal? - (v1.0) The netTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- netAmountIncludingTax decimal? - (v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- expectedReceiptDate string? - (v1.0) The expectedReceiptDate property for the Dynamics 365 Business Central purchaseInvoiceLine entity
- item Item? -
- account Account? -
microsoft.dynamics365businesscentral: RetainedEarningsStatement![](/images/permalink.svg)
Fields
- lineNumber int? - (v1.0) The lineNumber property for the Dynamics 365 Business Central retainedEarningsStatement entity
- display string? - (v1.0) The display property for the Dynamics 365 Business Central retainedEarningsStatement entity
- netChange decimal? - (v1.0) The netChange property for the Dynamics 365 Business Central retainedEarningsStatement entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central retainedEarningsStatement entity
- indentation int? - (v1.0) The indentation property for the Dynamics 365 Business Central retainedEarningsStatement entity
- dateFilter string? - (v1.0) The dateFilter property for the Dynamics 365 Business Central retainedEarningsStatement entity
microsoft.dynamics365businesscentral: SalesCreditMemo![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesCreditMemo entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central salesCreditMemo entity
- externalDocumentNumber string? - (v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesCreditMemo entity
- creditMemoDate string? - (v1.0) The creditMemoDate property for the Dynamics 365 Business Central salesCreditMemo entity
- dueDate string? - (v1.0) The dueDate property for the Dynamics 365 Business Central salesCreditMemo entity
- customerId string? - (v1.0) The customerId property for the Dynamics 365 Business Central salesCreditMemo entity
- contactId string? - (v1.0) The contactId property for the Dynamics 365 Business Central salesCreditMemo entity
- customerNumber string? - (v1.0) The customerNumber property for the Dynamics 365 Business Central salesCreditMemo entity
- customerName string? - (v1.0) The customerName property for the Dynamics 365 Business Central salesCreditMemo entity
- billToName string? - (v1.0) The billToName property for the Dynamics 365 Business Central salesCreditMemo entity
- billToCustomerId string? - (v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesCreditMemo entity
- billToCustomerNumber string? - (v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesCreditMemo entity
- sellingPostalAddress Postaladdresstype? -
- billingPostalAddress Postaladdresstype? -
- currencyId string? - (v1.0) The currencyId property for the Dynamics 365 Business Central salesCreditMemo entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central salesCreditMemo entity
- paymentTermsId string? - (v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesCreditMemo entity
- shipmentMethodId string? - (v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesCreditMemo entity
- salesperson string? - (v1.0) The salesperson property for the Dynamics 365 Business Central salesCreditMemo entity
- pricesIncludeTax boolean? - (v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesCreditMemo entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesCreditMemo entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesCreditMemo entity
- totalAmountExcludingTax decimal? - (v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesCreditMemo entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesCreditMemo entity
- totalAmountIncludingTax decimal? - (v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesCreditMemo entity
- status string? - (v1.0) The status property for the Dynamics 365 Business Central salesCreditMemo entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesCreditMemo entity
- invoiceId string? - (v1.0) The invoiceId property for the Dynamics 365 Business Central salesCreditMemo entity
- invoiceNumber string? - (v1.0) The invoiceNumber property for the Dynamics 365 Business Central salesCreditMemo entity
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central salesCreditMemo entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central salesCreditMemo entity
- salesCreditMemoLines SalesCreditMemoLine[]? -
- pdfDocument PdfDocument[]? -
- customer Customer? -
- currency Currency? -
- paymentTerm PaymentTerm? -
- shipmentMethod ShipmentMethod? -
microsoft.dynamics365businesscentral: SalesCreditMemoLine![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesCreditMemoLine entity
- documentId string? - (v1.0) The documentId property for the Dynamics 365 Business Central salesCreditMemoLine entity
- sequence int? - (v1.0) The sequence property for the Dynamics 365 Business Central salesCreditMemoLine entity
- itemId string? - (v1.0) The itemId property for the Dynamics 365 Business Central salesCreditMemoLine entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central salesCreditMemoLine entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central salesCreditMemoLine entity
- lineDetails Documentlineobjectdetailstype? -
- description string? - (v1.0) The description property for the Dynamics 365 Business Central salesCreditMemoLine entity
- unitOfMeasureId string? - (v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesCreditMemoLine entity
- unitOfMeasure Unitofmeasuretype? -
- unitPrice decimal? - (v1.0) The unitPrice property for the Dynamics 365 Business Central salesCreditMemoLine entity
- quantity decimal? - (v1.0) The quantity property for the Dynamics 365 Business Central salesCreditMemoLine entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity
- discountPercent decimal? - (v1.0) The discountPercent property for the Dynamics 365 Business Central salesCreditMemoLine entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesCreditMemoLine entity
- amountExcludingTax decimal? - (v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity
- taxCode string? - (v1.0) The taxCode property for the Dynamics 365 Business Central salesCreditMemoLine entity
- taxPercent decimal? - (v1.0) The taxPercent property for the Dynamics 365 Business Central salesCreditMemoLine entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity
- amountIncludingTax decimal? - (v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity
- invoiceDiscountAllocation decimal? - (v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesCreditMemoLine entity
- netAmount decimal? - (v1.0) The netAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity
- netTaxAmount decimal? - (v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity
- netAmountIncludingTax decimal? - (v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity
- shipmentDate string? - (v1.0) The shipmentDate property for the Dynamics 365 Business Central salesCreditMemoLine entity
- item Item? -
- account Account? -
microsoft.dynamics365businesscentral: SalesInvoice![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesInvoice entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central salesInvoice entity
- externalDocumentNumber string? - (v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesInvoice entity
- invoiceDate string? - (v1.0) The invoiceDate property for the Dynamics 365 Business Central salesInvoice entity
- dueDate string? - (v1.0) The dueDate property for the Dynamics 365 Business Central salesInvoice entity
- customerPurchaseOrderReference string? - (v1.0) The customerPurchaseOrderReference property for the Dynamics 365 Business Central salesInvoice entity
- customerId string? - (v1.0) The customerId property for the Dynamics 365 Business Central salesInvoice entity
- contactId string? - (v1.0) The contactId property for the Dynamics 365 Business Central salesInvoice entity
- customerNumber string? - (v1.0) The customerNumber property for the Dynamics 365 Business Central salesInvoice entity
- customerName string? - (v1.0) The customerName property for the Dynamics 365 Business Central salesInvoice entity
- billToName string? - (v1.0) The billToName property for the Dynamics 365 Business Central salesInvoice entity
- billToCustomerId string? - (v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesInvoice entity
- billToCustomerNumber string? - (v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesInvoice entity
- shipToName string? - (v1.0) The shipToName property for the Dynamics 365 Business Central salesInvoice entity
- shipToContact string? - (v1.0) The shipToContact property for the Dynamics 365 Business Central salesInvoice entity
- sellingPostalAddress Postaladdresstype? -
- billingPostalAddress Postaladdresstype? -
- shippingPostalAddress Postaladdresstype? -
- currencyId string? - (v1.0) The currencyId property for the Dynamics 365 Business Central salesInvoice entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central salesInvoice entity
- orderId string? - (v1.0) The orderId property for the Dynamics 365 Business Central salesInvoice entity
- orderNumber string? - (v1.0) The orderNumber property for the Dynamics 365 Business Central salesInvoice entity
- paymentTermsId string? - (v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesInvoice entity
- shipmentMethodId string? - (v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesInvoice entity
- salesperson string? - (v1.0) The salesperson property for the Dynamics 365 Business Central salesInvoice entity
- pricesIncludeTax boolean? - (v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesInvoice entity
- remainingAmount decimal? - (v1.0) The remainingAmount property for the Dynamics 365 Business Central salesInvoice entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesInvoice entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesInvoice entity
- totalAmountExcludingTax decimal? - (v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesInvoice entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesInvoice entity
- totalAmountIncludingTax decimal? - (v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesInvoice entity
- status string? - (v1.0) The status property for the Dynamics 365 Business Central salesInvoice entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesInvoice entity
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central salesInvoice entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central salesInvoice entity
- salesInvoiceLines SalesInvoiceLine[]? -
- pdfDocument PdfDocument[]? -
- customer Customer? -
- currency Currency? -
- paymentTerm PaymentTerm? -
- shipmentMethod ShipmentMethod? -
microsoft.dynamics365businesscentral: SalesInvoiceLine![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesInvoiceLine entity
- documentId string? - (v1.0) The documentId property for the Dynamics 365 Business Central salesInvoiceLine entity
- sequence int? - (v1.0) The sequence property for the Dynamics 365 Business Central salesInvoiceLine entity
- itemId string? - (v1.0) The itemId property for the Dynamics 365 Business Central salesInvoiceLine entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central salesInvoiceLine entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central salesInvoiceLine entity
- lineDetails Documentlineobjectdetailstype? -
- description string? - (v1.0) The description property for the Dynamics 365 Business Central salesInvoiceLine entity
- unitOfMeasureId string? - (v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesInvoiceLine entity
- unitOfMeasure Unitofmeasuretype? -
- unitPrice decimal? - (v1.0) The unitPrice property for the Dynamics 365 Business Central salesInvoiceLine entity
- quantity decimal? - (v1.0) The quantity property for the Dynamics 365 Business Central salesInvoiceLine entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
- discountPercent decimal? - (v1.0) The discountPercent property for the Dynamics 365 Business Central salesInvoiceLine entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesInvoiceLine entity
- amountExcludingTax decimal? - (v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity
- taxCode string? - (v1.0) The taxCode property for the Dynamics 365 Business Central salesInvoiceLine entity
- taxPercent decimal? - (v1.0) The taxPercent property for the Dynamics 365 Business Central salesInvoiceLine entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
- amountIncludingTax decimal? - (v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity
- invoiceDiscountAllocation decimal? - (v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesInvoiceLine entity
- netAmount decimal? - (v1.0) The netAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
- netTaxAmount decimal? - (v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
- netAmountIncludingTax decimal? - (v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity
- shipmentDate string? - (v1.0) The shipmentDate property for the Dynamics 365 Business Central salesInvoiceLine entity
- item Item? -
- account Account? -
microsoft.dynamics365businesscentral: SalesOrder![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesOrder entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central salesOrder entity
- externalDocumentNumber string? - (v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity
- orderDate string? - (v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity
- customerId string? - (v1.0) The customerId property for the Dynamics 365 Business Central salesOrder entity
- contactId string? - (v1.0) The contactId property for the Dynamics 365 Business Central salesOrder entity
- customerNumber string? - (v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity
- customerName string? - (v1.0) The customerName property for the Dynamics 365 Business Central salesOrder entity
- billToName string? - (v1.0) The billToName property for the Dynamics 365 Business Central salesOrder entity
- billToCustomerId string? - (v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesOrder entity
- billToCustomerNumber string? - (v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity
- shipToName string? - (v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity
- shipToContact string? - (v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity
- sellingPostalAddress Postaladdresstype? -
- billingPostalAddress Postaladdresstype? -
- shippingPostalAddress Postaladdresstype? -
- currencyId string? - (v1.0) The currencyId property for the Dynamics 365 Business Central salesOrder entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity
- pricesIncludeTax boolean? - (v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesOrder entity
- paymentTermsId string? - (v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesOrder entity
- shipmentMethodId string? - (v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesOrder entity
- salesperson string? - (v1.0) The salesperson property for the Dynamics 365 Business Central salesOrder entity
- partialShipping boolean? - (v1.0) The partialShipping property for the Dynamics 365 Business Central salesOrder entity
- requestedDeliveryDate string? - (v1.0) The requestedDeliveryDate property for the Dynamics 365 Business Central salesOrder entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrder entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrder entity
- totalAmountExcludingTax decimal? - (v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesOrder entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrder entity
- totalAmountIncludingTax decimal? - (v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesOrder entity
- fullyShipped boolean? - (v1.0) The fullyShipped property for the Dynamics 365 Business Central salesOrder entity
- status string? - (v1.0) The status property for the Dynamics 365 Business Central salesOrder entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesOrder entity
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central salesOrder entity
- salesOrderLines SalesOrderLine[]? -
- customer Customer? -
- currency Currency? -
- paymentTerm PaymentTerm? -
- shipmentMethod ShipmentMethod? -
microsoft.dynamics365businesscentral: SalesOrderLine![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesOrderLine entity
- documentId string? - (v1.0) The documentId property for the Dynamics 365 Business Central salesOrderLine entity
- sequence int? - (v1.0) The sequence property for the Dynamics 365 Business Central salesOrderLine entity
- itemId string? - (v1.0) The itemId property for the Dynamics 365 Business Central salesOrderLine entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central salesOrderLine entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central salesOrderLine entity
- lineDetails Documentlineobjectdetailstype? -
- description string? - (v1.0) The description property for the Dynamics 365 Business Central salesOrderLine entity
- unitOfMeasureId string? - (v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesOrderLine entity
- unitOfMeasure Unitofmeasuretype? -
- quantity decimal? - (v1.0) The quantity property for the Dynamics 365 Business Central salesOrderLine entity
- unitPrice decimal? - (v1.0) The unitPrice property for the Dynamics 365 Business Central salesOrderLine entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrderLine entity
- discountPercent decimal? - (v1.0) The discountPercent property for the Dynamics 365 Business Central salesOrderLine entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrderLine entity
- amountExcludingTax decimal? - (v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesOrderLine entity
- taxCode string? - (v1.0) The taxCode property for the Dynamics 365 Business Central salesOrderLine entity
- taxPercent decimal? - (v1.0) The taxPercent property for the Dynamics 365 Business Central salesOrderLine entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity
- amountIncludingTax decimal? - (v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity
- invoiceDiscountAllocation decimal? - (v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesOrderLine entity
- netAmount decimal? - (v1.0) The netAmount property for the Dynamics 365 Business Central salesOrderLine entity
- netTaxAmount decimal? - (v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity
- netAmountIncludingTax decimal? - (v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity
- shipmentDate string? - (v1.0) The shipmentDate property for the Dynamics 365 Business Central salesOrderLine entity
- shippedQuantity decimal? - (v1.0) The shippedQuantity property for the Dynamics 365 Business Central salesOrderLine entity
- invoicedQuantity decimal? - (v1.0) The invoicedQuantity property for the Dynamics 365 Business Central salesOrderLine entity
- invoiceQuantity decimal? - (v1.0) The invoiceQuantity property for the Dynamics 365 Business Central salesOrderLine entity
- shipQuantity decimal? - (v1.0) The shipQuantity property for the Dynamics 365 Business Central salesOrderLine entity
- item Item? -
- account Account? -
microsoft.dynamics365businesscentral: SalesQuote![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesQuote entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central salesQuote entity
- externalDocumentNumber string? - (v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesQuote entity
- documentDate string? - (v1.0) The documentDate property for the Dynamics 365 Business Central salesQuote entity
- dueDate string? - (v1.0) The dueDate property for the Dynamics 365 Business Central salesQuote entity
- customerId string? - (v1.0) The customerId property for the Dynamics 365 Business Central salesQuote entity
- contactId string? - (v1.0) The contactId property for the Dynamics 365 Business Central salesQuote entity
- customerNumber string? - (v1.0) The customerNumber property for the Dynamics 365 Business Central salesQuote entity
- customerName string? - (v1.0) The customerName property for the Dynamics 365 Business Central salesQuote entity
- billToName string? - (v1.0) The billToName property for the Dynamics 365 Business Central salesQuote entity
- billToCustomerId string? - (v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesQuote entity
- billToCustomerNumber string? - (v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesQuote entity
- shipToName string? - (v1.0) The shipToName property for the Dynamics 365 Business Central salesQuote entity
- shipToContact string? - (v1.0) The shipToContact property for the Dynamics 365 Business Central salesQuote entity
- sellingPostalAddress Postaladdresstype? -
- billingPostalAddress Postaladdresstype? -
- shippingPostalAddress Postaladdresstype? -
- currencyId string? - (v1.0) The currencyId property for the Dynamics 365 Business Central salesQuote entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central salesQuote entity
- paymentTermsId string? - (v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesQuote entity
- shipmentMethodId string? - (v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesQuote entity
- salesperson string? - (v1.0) The salesperson property for the Dynamics 365 Business Central salesQuote entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesQuote entity
- totalAmountExcludingTax decimal? - (v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesQuote entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesQuote entity
- totalAmountIncludingTax decimal? - (v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesQuote entity
- status string? - (v1.0) The status property for the Dynamics 365 Business Central salesQuote entity
- sentDate string? - (v1.0) The sentDate property for the Dynamics 365 Business Central salesQuote entity
- validUntilDate string? - (v1.0) The validUntilDate property for the Dynamics 365 Business Central salesQuote entity
- acceptedDate string? - (v1.0) The acceptedDate property for the Dynamics 365 Business Central salesQuote entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesQuote entity
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central salesQuote entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central salesQuote entity
- salesQuoteLines SalesQuoteLine[]? -
- pdfDocument PdfDocument[]? -
- customer Customer? -
- currency Currency? -
- paymentTerm PaymentTerm? -
- shipmentMethod ShipmentMethod? -
microsoft.dynamics365businesscentral: SalesQuoteLine![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central salesQuoteLine entity
- documentId string? - (v1.0) The documentId property for the Dynamics 365 Business Central salesQuoteLine entity
- sequence int? - (v1.0) The sequence property for the Dynamics 365 Business Central salesQuoteLine entity
- itemId string? - (v1.0) The itemId property for the Dynamics 365 Business Central salesQuoteLine entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central salesQuoteLine entity
- lineType string? - (v1.0) The lineType property for the Dynamics 365 Business Central salesQuoteLine entity
- lineDetails Documentlineobjectdetailstype? -
- description string? - (v1.0) The description property for the Dynamics 365 Business Central salesQuoteLine entity
- unitOfMeasureId string? - (v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesQuoteLine entity
- unitOfMeasure Unitofmeasuretype? -
- unitPrice decimal? - (v1.0) The unitPrice property for the Dynamics 365 Business Central salesQuoteLine entity
- quantity decimal? - (v1.0) The quantity property for the Dynamics 365 Business Central salesQuoteLine entity
- discountAmount decimal? - (v1.0) The discountAmount property for the Dynamics 365 Business Central salesQuoteLine entity
- discountPercent decimal? - (v1.0) The discountPercent property for the Dynamics 365 Business Central salesQuoteLine entity
- discountAppliedBeforeTax boolean? - (v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesQuoteLine entity
- amountExcludingTax decimal? - (v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesQuoteLine entity
- taxCode string? - (v1.0) The taxCode property for the Dynamics 365 Business Central salesQuoteLine entity
- taxPercent decimal? - (v1.0) The taxPercent property for the Dynamics 365 Business Central salesQuoteLine entity
- totalTaxAmount decimal? - (v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesQuoteLine entity
- amountIncludingTax decimal? - (v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesQuoteLine entity
- netAmount decimal? - (v1.0) The netAmount property for the Dynamics 365 Business Central salesQuoteLine entity
- netTaxAmount decimal? - (v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesQuoteLine entity
- netAmountIncludingTax decimal? - (v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesQuoteLine entity
- item Item? -
- account Account? -
microsoft.dynamics365businesscentral: ShipmentMethod![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central shipmentMethod entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central shipmentMethod entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central shipmentMethod entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central shipmentMethod entity
microsoft.dynamics365businesscentral: TaxArea![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central taxArea entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central taxArea entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central taxArea entity
- taxType string? - (v1.0) The taxType property for the Dynamics 365 Business Central taxArea entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central taxArea entity
microsoft.dynamics365businesscentral: TaxGroup![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central taxGroup entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central taxGroup entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central taxGroup entity
- taxType string? - (v1.0) The taxType property for the Dynamics 365 Business Central taxGroup entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central taxGroup entity
microsoft.dynamics365businesscentral: TimeRegistrationEntry![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central timeRegistrationEntry entity
- employeeId string? - (v1.0) The employeeId property for the Dynamics 365 Business Central timeRegistrationEntry entity
- employeeNumber string? - (v1.0) The employeeNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity
- jobId string? - (v1.0) The jobId property for the Dynamics 365 Business Central timeRegistrationEntry entity
- jobNumber string? - (v1.0) The jobNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity
- absence string? - (v1.0) The absence property for the Dynamics 365 Business Central timeRegistrationEntry entity
- lineNumber int? - (v1.0) The lineNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity
- date string? - (v1.0) The date property for the Dynamics 365 Business Central timeRegistrationEntry entity
- quantity decimal? - (v1.0) The quantity property for the Dynamics 365 Business Central timeRegistrationEntry entity
- status string? - (v1.0) The status property for the Dynamics 365 Business Central timeRegistrationEntry entity
- unitOfMeasureId string? - (v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central timeRegistrationEntry entity
- unitOfMeasure Unitofmeasuretype? -
- dimensions Dimensiontype[]? -
- lastModfiedDateTime string? - (v1.0) The lastModfiedDateTime property for the Dynamics 365 Business Central timeRegistrationEntry entity
- project Project? -
microsoft.dynamics365businesscentral: TrialBalance![](/images/permalink.svg)
Fields
- number string? - (v1.0) The number property for the Dynamics 365 Business Central trialBalance entity
- accountId string? - (v1.0) The accountId property for the Dynamics 365 Business Central trialBalance entity
- accountType string? - (v1.0) The accountType property for the Dynamics 365 Business Central trialBalance entity
- display string? - (v1.0) The display property for the Dynamics 365 Business Central trialBalance entity
- totalDebit string? - (v1.0) The totalDebit property for the Dynamics 365 Business Central trialBalance entity
- totalCredit string? - (v1.0) The totalCredit property for the Dynamics 365 Business Central trialBalance entity
- balanceAtDateDebit string? - (v1.0) The balanceAtDateDebit property for the Dynamics 365 Business Central trialBalance entity
- balanceAtDateCredit string? - (v1.0) The balanceAtDateCredit property for the Dynamics 365 Business Central trialBalance entity
- dateFilter string? - (v1.0) The dateFilter property for the Dynamics 365 Business Central trialBalance entity
- account Account? -
microsoft.dynamics365businesscentral: UnitOfMeasure![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central unitOfMeasure entity
- code string? - (v1.0) The code property for the Dynamics 365 Business Central unitOfMeasure entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central unitOfMeasure entity
- internationalStandardCode string? - (v1.0) The internationalStandardCode property for the Dynamics 365 Business Central unitOfMeasure entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central unitOfMeasure entity
microsoft.dynamics365businesscentral: Unitofmeasuretype![](/images/permalink.svg)
Fields
- code string? - (v1.0) The code property for the Dynamics 365 Business Central unitofmeasuretype entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central unitofmeasuretype entity
- symbol string? - (v1.0) The symbol property for the Dynamics 365 Business Central unitofmeasuretype entity
- unitConversion Itemunitofmeasureconversiontype? -
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- itemCategory ItemCategory? -
microsoft.dynamics365businesscentral: Vendor![](/images/permalink.svg)
Fields
- id string? - (v1.0) The id property for the Dynamics 365 Business Central vendor entity
- number string? - (v1.0) The number property for the Dynamics 365 Business Central vendor entity
- displayName string? - (v1.0) The displayName property for the Dynamics 365 Business Central vendor entity
- address Postaladdresstype? -
- phoneNumber string? - (v1.0) The phoneNumber property for the Dynamics 365 Business Central vendor entity
- email string? - (v1.0) The email property for the Dynamics 365 Business Central vendor entity
- website string? - (v1.0) The website property for the Dynamics 365 Business Central vendor entity
- taxRegistrationNumber string? - (v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central vendor entity
- currencyId string? - (v1.0) The currencyId property for the Dynamics 365 Business Central vendor entity
- currencyCode string? - (v1.0) The currencyCode property for the Dynamics 365 Business Central vendor entity
- irs1099Code string? - (v1.0) The irs1099Code property for the Dynamics 365 Business Central vendor entity
- paymentTermsId string? - (v1.0) The paymentTermsId property for the Dynamics 365 Business Central vendor entity
- paymentMethodId string? - (v1.0) The paymentMethodId property for the Dynamics 365 Business Central vendor entity
- taxLiable boolean? - (v1.0) The taxLiable property for the Dynamics 365 Business Central vendor entity
- blocked string? - (v1.0) The blocked property for the Dynamics 365 Business Central vendor entity
- balance decimal? - (v1.0) The balance property for the Dynamics 365 Business Central vendor entity
- lastModifiedDateTime string? - (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central vendor entity
- picture Picture[]? -
- defaultDimensions DefaultDimensions[]? -
- currency Currency? -
- paymentTerm PaymentTerm? -
- paymentMethod PaymentMethod? -
microsoft.dynamics365businesscentral: VendorPurchase![](/images/permalink.svg)
Fields
- vendorId string? - (v1.0) The vendorId property for the Dynamics 365 Business Central vendorPurchase entity
- vendorNumber string? - (v1.0) The vendorNumber property for the Dynamics 365 Business Central vendorPurchase entity
- name string? - (v1.0) The name property for the Dynamics 365 Business Central vendorPurchase entity
- totalPurchaseAmount decimal? - (v1.0) The totalPurchaseAmount property for the Dynamics 365 Business Central vendorPurchase entity
- dateFilter_FilterOnly string? - (v1.0) The dateFilter_FilterOnly property for the Dynamics 365 Business Central vendorPurchase entity
Import
import ballerinax/microsoft.dynamics365businesscentral;
Metadata
Released date: over 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 6
Current verison: 3
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Vendor/Microsoft
Contributors