DocumentsCorePack for BC (Preview)
DocumentsCorePack BC enables you to create and process documents using Microsoft Word layouts and Business Central data. Integrate document processes into your workflows with a no-code approach and work with documents and layouts directly from your automated processes.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | mscrm-addons.com |
| URL | https://support.mscrm-addons.com |
| support@mscrm-addons.com |
| Connector Metadata | |
|---|---|
| Publisher | mscrm-addons.com ( PTM EDV Systeme ) |
| Website | https://poweraddons.com |
| Privacy policy | https://www.mscrm-addons.com/LegalDocuments |
| Categories | Productivity;Sales and CRM |
DocumentsCorePack BC
DocumentsCorePack BC enables you to create and process documents using Microsoft Word layouts and Business Central data. Integrate document processes into your workflows with a no-code approach and work with documents and layouts directly from your automated processes.
The connector provides a no-code way to work with Business Central documents and layouts directly from Power Automate.
Follow this link to see step-by-step tutorials, how-tos and get detailed information.
Publisher: PTM EDV Systeme GmbH - mscrm-addons.com Corp.
Prerequisites
- Microsoft Dynamics 365 Business Central Online environment
- DocumentsCorePack for Business Central
- DocumentsCorePack Service
You can start a trial using this link.
Configure DocumentsCorePack for Business Central
DocumentsCorePack for Business Central needs to be installed and configured in your Business Central environment before using the connector.
For information about installation and configuration, please refer to the DocumentsCorePack for Business Central documentation.
API documentation
The API documentation can be found here.
Supported Operations
Create document
Creates a new document based on Business Central data and a selected layout.
Create DocumentJob (async)
Creates a new request to generate a new document based on Business Central data and a selected layout. The action does NOT wait for a result.
Get DocumentJob result
Retrieves status information of a DocumentJob. The result will include the generated document.
Get DocumentJob status
Retrieves the status of a DocumentJob.
Get document templates
Retrieves a list of available DocumentsCorePack layouts.
Get Profiles for a User APIKey
Retrieves all Profile Ids for this APIKey.
Get Printers
Retrieve available printers.
Who am I
Retrieve information about the used APIKey and associated DocumentsCorePack Service.
Obtaining Credentials
First of all, you need to Create an Account and sign up for a DocumentsCorePack Service. A 14-day free trial is available.
For information about configuring DocumentsCorePack for Business Central, please refer to the DocumentsCorePack for Business Central setup documentation.
If you have a question, please send an email to support@mscrm-addons.com.
Known Issues and Limitations
N/A
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Actions
| Create document (Preview) |
Creates a new document. For more information, https://short.mscrm-addons.com/createdocumentjob |
|
Create Document |
Creates a new document. The action does NOT wait for a result. For more information, https://short.mscrm-addons.com/createdocumentjobasync |
| Get document templates (Preview) |
Retrieves a list of available DocumentsCorePackBusinessCentral templates. |
|
Get Document |
Retrieves status information of a DocumentJob. The result will include the generated document. |
|
Get Document |
Retrieves the status of a DocumentJob. |
| Get Printers (Preview) |
Retrieve available printers. |
| Get Profiles for a User APIKey (Preview) |
Retrieves all Profile Ids for this APIKey. |
| Who am I (Preview) |
Retrieve information about the used APIKey and associated DocumentsCorePack Service. |
Create document (Preview)
Creates a new document. For more information, https://short.mscrm-addons.com/createdocumentjob
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Layout
|
Template | True | uuid |
Choose layout for this DocumentJob. |
|
Record ID
|
EntityId | True | uuid |
Unique identifier of the record to run this layout for. |
|
Sync. Callback
|
RequestSynchronousCallback | boolean |
Use synchronous processing when accept/retry-after isn't supported. |
|
|
File Type
|
FileType | True | string |
Choose filetype. |
|
Name
|
Name | string |
Name/Id of the prompt. |
|
|
Value
|
Value | string |
Value of the prompt. |
|
|
IsValid
|
IsValid | boolean | ||
|
Environment
|
Environment | string |
Choose the environment for this operation. |
Returns
Create DocumentJob (async) (Preview)
Creates a new document. The action does NOT wait for a result. For more information, https://short.mscrm-addons.com/createdocumentjobasync
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Layout
|
Template | True | uuid |
Choose layout for this DocumentJob. |
|
Record ID
|
EntityId | True | uuid |
Unique identifier of the record to run this layout for. |
|
Sync. Callback
|
RequestSynchronousCallback | boolean |
Use synchronous processing when accept/retry-after isn't supported. |
|
|
File Type
|
FileType | True | string |
Choose filetype. |
|
Name
|
Name | string |
Name/Id of the prompt. |
|
|
Value
|
Value | string |
Value of the prompt. |
|
|
IsValid
|
IsValid | boolean | ||
|
Environment
|
Environment | string |
Choose the environment for this operation. |
Returns
Get document templates (Preview)
Retrieves a list of available DocumentsCorePackBusinessCentral templates.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Table Name
|
EntityName | string |
Filter by Entity (etc or etn). Optional wildcard [etn] |
|
|
Template Filter
|
TemplateNameFilter | string |
Filter by template name. Optional wildcard [name] |
|
|
Group Filter
|
GroupFilter | string |
Filter by group name. Optional wildcard [name] |
|
|
User
|
UserId | string |
Only retrieve templates accessible to this user |
|
|
Environment
|
Environment | string |
Choose the Environment for this operation. |
Returns
- response
- array of JSONDCPTemplate
Get DocumentJob result (Preview)
Retrieves status information of a DocumentJob. The result will include the generated document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
Unique identifier of the DocumentJob. |
|
Environment
|
Environment | string |
Choose environment for this operation. |
Returns
Get DocumentJob status (Preview)
Retrieves the status of a DocumentJob.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
DocumentJob ID
|
DocumentJobId | True | uuid |
Unique identifier of the DocumentJob to retrieve the status of. |
|
Environment
|
Environment | string |
Choose environment for this operation. |
Returns
Get Printers (Preview)
Retrieve available printers.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Environment
|
Environment | string |
Choose the Environment for this operation. |
|
|
User
|
User | string |
Optional, only list printers accessible to this user. |
Returns
- response
- array of JSONPrinterResponse
Get Profiles for a User APIKey (Preview)
Who am I (Preview)
Retrieve information about the used APIKey and associated DocumentsCorePack Service.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Environment
|
Environment | string |
Choose environment for this operation. |
Returns
- Body
- WhoAmiV5
Definitions
DocumentJobResponseV2
| Name | Path | Type | Description |
|---|---|---|---|
|
File name
|
File name | string | |
|
File size
|
File size | integer | |
|
Document content
|
Document content | byte | |
|
Mime-Type
|
Mime-Type | string | |
|
Temporary Record Id
|
Temporary Record Id | string | |
|
Success
|
Success | boolean | |
|
Return value
|
Return value | string | |
|
Return value 2
|
Return value 2 | string | |
|
DocumentJobId
|
DocumentJobId | string |
DocumentJobStatusResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Success
|
Success | boolean | |
|
Return value
|
Return value | string | |
|
Return value 2
|
Return value 2 | string | |
|
DocumentJobId
|
DocumentJobId | string |
JSONDCPTemplate
| Name | Path | Type | Description |
|---|---|---|---|
|
ptm_mscrmaddons_dcptemplatesid
|
ptm_mscrmaddons_dcptemplatesid | string | |
|
ptm_name
|
ptm_name | string | |
|
ptm_entitytype
|
ptm_entitytype | string |
JSONEnvironmentV3
| Name | Path | Type | Description |
|---|---|---|---|
|
EnvironmentName
|
EnvironmentName | string | |
|
EnvironmentId
|
EnvironmentId | string |
JSONPrinterResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
DCPPrinterName
|
DCPPrinterName | string |
WhoAmiV5
| Name | Path | Type | Description |
|---|---|---|---|
|
ApiKey
|
ApiKey | string | |
|
ApiOwner
|
ApiOwner | string | |
|
Environment
|
Environment | integer | |
|
ServiceAlive
|
ServiceAlive | boolean | |
|
ApiVersion
|
ApiVersion | string |