Module microsoft.dynamics365.finance.workflow

ballerinax/microsoft.dynamics365.finance.workflow Ballerina library

0.8.0

Overview

Microsoft Dynamics 365 Finance is Microsoft's cloud ERP solution for financial management, covering general ledger, accounts receivable and payable, fixed assets, budgeting, cash and bank management, and tax.

The microsoft.dynamics365.finance.workflow connector provides access to Microsoft Dynamics 365 Finance Workflow entities via the OData REST API.

Key Features

Manage workflow entities in Microsoft Dynamics 365 Finance
Support for list, create, read, update, and delete operations
OAuth2 client credentials authentication

Setup guide

Prerequisites

A Microsoft Dynamics 365 Finance & Operations environment (cloud-hosted or sandbox)
An Azure Active Directory (Entra ID) app registration with API permissions for Dynamics 365

Step 1: Register an application in Azure AD

Sign in to the Azure portal and navigate to Azure Active Directory → App registrations → New registration.
Give the application a name, select the appropriate account type, and click Register.
Note the Application (client) ID and Directory (tenant) ID from the overview page.
Under Certificates & secrets, create a new client secret and note the value immediately — it is only shown once.

Step 2: Grant Dynamics 365 API permissions

In the app registration, go to API permissions → Add a permission → APIs my organization uses.
Search for Dynamics 365 (or Microsoft Dynamics ERP) and add the user_impersonation (or .default) delegated/application scope.
Click Grant admin consent for your tenant.

Step 3: Add the app as a D365 user

In your D365 Finance environment, go to System administration → Users → New.
Set the User ID and User name, then paste the Azure AD Application (client) ID into the Azure AD application field.
Assign appropriate security roles and save.

Quickstart

To use the microsoft.dynamics365.finance.workflow connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/microsoft.dynamics365.finance.workflow;

Step 2: Instantiate a new connector


configurable string tenantId = ?;
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string serviceUrl = ?;   // e.g. "https://<env>.operations.dynamics.com/data"

workflow:Client cl = check new ({
    config = {
        auth: {
            tokenUrl: string `https://login.microsoftonline.com/${tenantId}/oauth2/v2.0/token`,
            clientId,
            clientSecret,
            scopes: [string `${serviceUrl}/.default`]
        }
    },
    serviceUrl
);

Step 3: Invoke the connector operation


workflow:ActionClassesCollection results = check cl->listActionClasses();

Step 4: Run the Ballerina application


bal run

Examples

The Dynamics 365 Finance Ballerina connectors provide practical examples illustrating usage in various scenarios. Explore these examples.

Clients

microsoft.dynamics365.finance.workflow: Client

Isolated

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://your-org.operations.dynamics.com/data" - URL of the target service

listActionClasses

Isolated FunctionRemote Function

function listActionClasses(map<string|string[]> headers, *ListActionClassesQueries queries) returns ActionClassesCollection|error

List ActionClasses

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListActionClassesQueries - Queries to be sent with the request

Return Type

ActionClassesCollection|error - Collection of ActionClass

createActionClasses

Isolated FunctionRemote Function

function createActionClasses(ActionClass payload, map<string|string[]> headers) returns ActionClass|error

Create ActionClass

Parameters

payload ActionClass - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ActionClass|error - ActionClass created

getActionClasses

Isolated FunctionRemote Function

function getActionClasses(string dataAreaId, string executableClass, map<string|string[]> headers, *GetActionClassesQueries queries) returns ActionClass|error

Get ActionClass by key

Parameters

dataAreaId string - The company data area identifier

executableClass string - The executable class key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetActionClassesQueries - Queries to be sent with the request

Return Type

ActionClass|error - ActionClass

deleteActionClasses

Isolated FunctionRemote Function

function deleteActionClasses(string dataAreaId, string executableClass, DeleteActionClassesHeaders headers) returns error?

Delete ActionClass

Parameters

dataAreaId string - The company data area identifier

executableClass string - The executable class key field

headers DeleteActionClassesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - ActionClass deleted

updateActionClasses

Isolated FunctionRemote Function

function updateActionClasses(string dataAreaId, string executableClass, ActionClass payload, UpdateActionClassesHeaders headers) returns ActionClass|error

Update ActionClass

Parameters

dataAreaId string - The company data area identifier

executableClass string - The executable class key field

payload ActionClass - The request body

headers UpdateActionClassesHeaders (default {}) - Headers to be sent with the request

Return Type

ActionClass|error - ActionClass updated

listActions

Isolated FunctionRemote Function

function listActions(map<string|string[]> headers, *ListActionsQueries queries) returns ActionsCollection|error

List Actions

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListActionsQueries - Queries to be sent with the request

Return Type

ActionsCollection|error - Collection of Action

createActions

Isolated FunctionRemote Function

function createActions(Action payload, map<string|string[]> headers) returns Action|error

Create Action

Parameters

payload Action - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Action|error - Action created

getActions

Isolated FunctionRemote Function

function getActions(string dataAreaId, string action, map<string|string[]> headers, *GetActionsQueries queries) returns Action|error

Get Action by key

Parameters

dataAreaId string - The company data area identifier

action string - The action key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetActionsQueries - Queries to be sent with the request

Return Type

Action|error - Action

deleteActions

Isolated FunctionRemote Function

function deleteActions(string dataAreaId, string action, DeleteActionsHeaders headers) returns error?

Delete Action

Parameters

dataAreaId string - The company data area identifier

action string - The action key field

headers DeleteActionsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - Action deleted

updateActions

Isolated FunctionRemote Function

function updateActions(string dataAreaId, string action, Action payload, UpdateActionsHeaders headers) returns Action|error

Update Action

Parameters

dataAreaId string - The company data area identifier

action string - The action key field

payload Action - The request body

headers UpdateActionsHeaders (default {}) - Headers to be sent with the request

Return Type

Action|error - Action updated

listAdvancedRules

Isolated FunctionRemote Function

function listAdvancedRules(map<string|string[]> headers, *ListAdvancedRulesQueries queries) returns AdvancedRulesCollection|error

List AdvancedRules

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListAdvancedRulesQueries - Queries to be sent with the request

Return Type

AdvancedRulesCollection|error - Collection of AdvancedRule

createAdvancedRules

Isolated FunctionRemote Function

function createAdvancedRules(AdvancedRule payload, map<string|string[]> headers) returns AdvancedRule|error

Create AdvancedRule

Parameters

payload AdvancedRule - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AdvancedRule|error - AdvancedRule created

getAdvancedRules

Isolated FunctionRemote Function

function getAdvancedRules(string accountStructure, string advancedRuleName, string status, map<string|string[]> headers, *GetAdvancedRulesQueries queries) returns AdvancedRule|error

Get AdvancedRule by key

Parameters

accountStructure string - The account structure key field

advancedRuleName string - The advanced rule name key field

status string - The status key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAdvancedRulesQueries - Queries to be sent with the request

Return Type

AdvancedRule|error - AdvancedRule

deleteAdvancedRules

Isolated FunctionRemote Function

function deleteAdvancedRules(string accountStructure, string advancedRuleName, string status, DeleteAdvancedRulesHeaders headers) returns error?

Delete AdvancedRule

Parameters

accountStructure string - The account structure key field

advancedRuleName string - The advanced rule name key field

status string - The status key field

headers DeleteAdvancedRulesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - AdvancedRule deleted

updateAdvancedRules

Isolated FunctionRemote Function

function updateAdvancedRules(string accountStructure, string advancedRuleName, string status, AdvancedRule payload, UpdateAdvancedRulesHeaders headers) returns AdvancedRule|error

Update AdvancedRule

Parameters

accountStructure string - The account structure key field

advancedRuleName string - The advanced rule name key field

status string - The status key field

payload AdvancedRule - The request body

headers UpdateAdvancedRulesHeaders (default {}) - Headers to be sent with the request

Return Type

AdvancedRule|error - AdvancedRule updated

listApprovalUsers

Isolated FunctionRemote Function

function listApprovalUsers(map<string|string[]> headers, *ListApprovalUsersQueries queries) returns ApprovalUsersCollection|error

List ApprovalUsers

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListApprovalUsersQueries - Queries to be sent with the request

Return Type

ApprovalUsersCollection|error - Collection of ApprovalUser

createApprovalUsers

Isolated FunctionRemote Function

function createApprovalUsers(ApprovalUser payload, map<string|string[]> headers) returns ApprovalUser|error

Create ApprovalUser

Parameters

payload ApprovalUser - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ApprovalUser|error - ApprovalUser created

getApprovalUsers

Isolated FunctionRemote Function

function getApprovalUsers(string userId, map<string|string[]> headers, *GetApprovalUsersQueries queries) returns ApprovalUser|error

Get ApprovalUser by key

Parameters

userId string - The user id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetApprovalUsersQueries - Queries to be sent with the request

Return Type

ApprovalUser|error - ApprovalUser

deleteApprovalUsers

Isolated FunctionRemote Function

function deleteApprovalUsers(string userId, DeleteApprovalUsersHeaders headers) returns error?

Delete ApprovalUser

Parameters

userId string - The user id key field

headers DeleteApprovalUsersHeaders (default {}) - Headers to be sent with the request

Return Type

error? - ApprovalUser deleted

updateApprovalUsers

Isolated FunctionRemote Function

function updateApprovalUsers(string userId, ApprovalUser payload, UpdateApprovalUsersHeaders headers) returns ApprovalUser|error

Update ApprovalUser

Parameters

userId string - The user id key field

payload ApprovalUser - The request body

headers UpdateApprovalUsersHeaders (default {}) - Headers to be sent with the request

Return Type

ApprovalUser|error - ApprovalUser updated

listBatchGroups

Isolated FunctionRemote Function

function listBatchGroups(map<string|string[]> headers, *ListBatchGroupsQueries queries) returns BatchGroupsCollection|error

List BatchGroups

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListBatchGroupsQueries - Queries to be sent with the request

Return Type

BatchGroupsCollection|error - Collection of BatchGroup

createBatchGroups

Isolated FunctionRemote Function

function createBatchGroups(BatchGroup payload, map<string|string[]> headers) returns BatchGroup|error

Create BatchGroup

Parameters

payload BatchGroup - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BatchGroup|error - BatchGroup created

getBatchGroups

Isolated FunctionRemote Function

function getBatchGroups(string groupId, string serverId, map<string|string[]> headers, *GetBatchGroupsQueries queries) returns BatchGroup|error

Get BatchGroup by key

Parameters

groupId string - The group id key field

serverId string - The server id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBatchGroupsQueries - Queries to be sent with the request

Return Type

BatchGroup|error - BatchGroup

deleteBatchGroups

Isolated FunctionRemote Function

function deleteBatchGroups(string groupId, string serverId, DeleteBatchGroupsHeaders headers) returns error?

Delete BatchGroup

Parameters

groupId string - The group id key field

serverId string - The server id key field

headers DeleteBatchGroupsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - BatchGroup deleted

updateBatchGroups

Isolated FunctionRemote Function

function updateBatchGroups(string groupId, string serverId, BatchGroup payload, UpdateBatchGroupsHeaders headers) returns BatchGroup|error

Update BatchGroup

Parameters

groupId string - The group id key field

serverId string - The server id key field

payload BatchGroup - The request body

headers UpdateBatchGroupsHeaders (default {}) - Headers to be sent with the request

Return Type

BatchGroup|error - BatchGroup updated

listBatchJobs

Isolated FunctionRemote Function

function listBatchJobs(map<string|string[]> headers, *ListBatchJobsQueries queries) returns BatchJobsCollection|error

List BatchJobs

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListBatchJobsQueries - Queries to be sent with the request

Return Type

BatchJobsCollection|error - Collection of BatchJob

createBatchJobs

Isolated FunctionRemote Function

function createBatchJobs(BatchJob payload, map<string|string[]> headers) returns BatchJob|error

Create BatchJob

Parameters

payload BatchJob - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BatchJob|error - BatchJob created

getBatchJobs

Isolated FunctionRemote Function

function getBatchJobs(int batchJobRecId, map<string|string[]> headers, *GetBatchJobsQueries queries) returns BatchJob|error

Get BatchJob by key

Parameters

batchJobRecId int - The batch job rec id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBatchJobsQueries - Queries to be sent with the request

Return Type

BatchJob|error - BatchJob

deleteBatchJobs

Isolated FunctionRemote Function

function deleteBatchJobs(int batchJobRecId, DeleteBatchJobsHeaders headers) returns error?

Delete BatchJob

Parameters

batchJobRecId int - The batch job rec id key field

headers DeleteBatchJobsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - BatchJob deleted

updateBatchJobs

Isolated FunctionRemote Function

function updateBatchJobs(int batchJobRecId, BatchJob payload, UpdateBatchJobsHeaders headers) returns BatchJob|error

Update BatchJob

Parameters

batchJobRecId int - The batch job rec id key field

payload BatchJob - The request body

headers UpdateBatchJobsHeaders (default {}) - Headers to be sent with the request

Return Type

BatchJob|error - BatchJob updated

listDatabaseLogs

Isolated FunctionRemote Function

function listDatabaseLogs(map<string|string[]> headers, *ListDatabaseLogsQueries queries) returns DatabaseLogsCollection|error

List DatabaseLogs

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListDatabaseLogsQueries - Queries to be sent with the request

Return Type

DatabaseLogsCollection|error - Collection of DatabaseLog

createDatabaseLogs

Isolated FunctionRemote Function

function createDatabaseLogs(DatabaseLog payload, map<string|string[]> headers) returns DatabaseLog|error

Create DatabaseLog

Parameters

payload DatabaseLog - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DatabaseLog|error - DatabaseLog created

getDatabaseLogs

Isolated FunctionRemote Function

function getDatabaseLogs(string dataAreaId, int tableRecId, int logRecId, int tableIdNumber, map<string|string[]> headers, *GetDatabaseLogsQueries queries) returns DatabaseLog|error

Get DatabaseLog by key

Parameters

dataAreaId string - The company data area identifier

tableRecId int - The table rec id key field

logRecId int - The log rec id key field

tableIdNumber int - The table id number key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDatabaseLogsQueries - Queries to be sent with the request

Return Type

DatabaseLog|error - DatabaseLog

deleteDatabaseLogs

Isolated FunctionRemote Function

function deleteDatabaseLogs(string dataAreaId, int tableRecId, int logRecId, int tableIdNumber, DeleteDatabaseLogsHeaders headers) returns error?

Delete DatabaseLog

Parameters

dataAreaId string - The company data area identifier

tableRecId int - The table rec id key field

logRecId int - The log rec id key field

tableIdNumber int - The table id number key field

headers DeleteDatabaseLogsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - DatabaseLog deleted

updateDatabaseLogs

Isolated FunctionRemote Function

function updateDatabaseLogs(string dataAreaId, int tableRecId, int logRecId, int tableIdNumber, DatabaseLog payload, UpdateDatabaseLogsHeaders headers) returns DatabaseLog|error

Update DatabaseLog

Parameters

dataAreaId string - The company data area identifier

tableRecId int - The table rec id key field

logRecId int - The log rec id key field

tableIdNumber int - The table id number key field

payload DatabaseLog - The request body

headers UpdateDatabaseLogsHeaders (default {}) - Headers to be sent with the request

Return Type

DatabaseLog|error - DatabaseLog updated

listOperations

Isolated FunctionRemote Function

function listOperations(map<string|string[]> headers, *ListOperationsQueries queries) returns OperationsCollection|error

List Operations

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListOperationsQueries - Queries to be sent with the request

Return Type

OperationsCollection|error - Collection of Operation

createOperations

Isolated FunctionRemote Function

function createOperations(Operation payload, map<string|string[]> headers) returns Operation|error

Create Operation

Parameters

payload Operation - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Operation|error - Operation created

getOperations

Isolated FunctionRemote Function

function getOperations(string dataAreaId, string operationId, map<string|string[]> headers, *GetOperationsQueries queries) returns Operation|error

Get Operation by key

Parameters

dataAreaId string - The company data area identifier

operationId string - The operation id key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetOperationsQueries - Queries to be sent with the request

Return Type

Operation|error - Operation

deleteOperations

Isolated FunctionRemote Function

function deleteOperations(string dataAreaId, string operationId, DeleteOperationsHeaders headers) returns error?

Delete Operation

Parameters

dataAreaId string - The company data area identifier

operationId string - The operation id key field

headers DeleteOperationsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - Operation deleted

updateOperations

Isolated FunctionRemote Function

function updateOperations(string dataAreaId, string operationId, Operation payload, UpdateOperationsHeaders headers) returns Operation|error

Update Operation

Parameters

dataAreaId string - The company data area identifier

operationId string - The operation id key field

payload Operation - The request body

headers UpdateOperationsHeaders (default {}) - Headers to be sent with the request

Return Type

Operation|error - Operation updated

listPolicyRules

Isolated FunctionRemote Function

function listPolicyRules(map<string|string[]> headers, *ListPolicyRulesQueries queries) returns PolicyRulesCollection|error

List PolicyRules

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPolicyRulesQueries - Queries to be sent with the request

Return Type

PolicyRulesCollection|error - Collection of PolicyRule

createPolicyRules

Isolated FunctionRemote Function

function createPolicyRules(PolicyRule payload, map<string|string[]> headers) returns PolicyRule|error

Create PolicyRule

Parameters

payload PolicyRule - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PolicyRule|error - PolicyRule created

getPolicyRules

Isolated FunctionRemote Function

function getPolicyRules(string policyName, string policyType, string policyRuleName, string validFrom, map<string|string[]> headers, *GetPolicyRulesQueries queries) returns PolicyRule|error

Get PolicyRule by key

Parameters

policyName string - The policy name key field

policyType string - The policy type key field

policyRuleName string - The policy rule name key field

validFrom string - The valid from key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPolicyRulesQueries - Queries to be sent with the request

Return Type

PolicyRule|error - PolicyRule

deletePolicyRules

Isolated FunctionRemote Function

function deletePolicyRules(string policyName, string policyType, string policyRuleName, string validFrom, DeletePolicyRulesHeaders headers) returns error?

Delete PolicyRule

Parameters

policyName string - The policy name key field

policyType string - The policy type key field

policyRuleName string - The policy rule name key field

validFrom string - The valid from key field

headers DeletePolicyRulesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - PolicyRule deleted

updatePolicyRules

Isolated FunctionRemote Function

function updatePolicyRules(string policyName, string policyType, string policyRuleName, string validFrom, PolicyRule payload, UpdatePolicyRulesHeaders headers) returns PolicyRule|error

Update PolicyRule

Parameters

policyName string - The policy name key field

policyType string - The policy type key field

policyRuleName string - The policy rule name key field

validFrom string - The valid from key field

payload PolicyRule - The request body

headers UpdatePolicyRulesHeaders (default {}) - Headers to be sent with the request

Return Type

PolicyRule|error - PolicyRule updated

listPolicyTypes

Isolated FunctionRemote Function

function listPolicyTypes(map<string|string[]> headers, *ListPolicyTypesQueries queries) returns PolicyTypesCollection|error

List PolicyTypes

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPolicyTypesQueries - Queries to be sent with the request

Return Type

PolicyTypesCollection|error - Collection of PolicyType

createPolicyTypes

Isolated FunctionRemote Function

function createPolicyTypes(PolicyType payload, map<string|string[]> headers) returns PolicyType|error

Create PolicyType

Parameters

payload PolicyType - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PolicyType|error - PolicyType created

getPolicyTypes

Isolated FunctionRemote Function

function getPolicyTypes(string policyType, map<string|string[]> headers, *GetPolicyTypesQueries queries) returns PolicyType|error

Get PolicyType by key

Parameters

policyType string - The policy type key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPolicyTypesQueries - Queries to be sent with the request

Return Type

PolicyType|error - PolicyType

deletePolicyTypes

Isolated FunctionRemote Function

function deletePolicyTypes(string policyType, DeletePolicyTypesHeaders headers) returns error?

Delete PolicyType

Parameters

policyType string - The policy type key field

headers DeletePolicyTypesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - PolicyType deleted

updatePolicyTypes

Isolated FunctionRemote Function

function updatePolicyTypes(string policyType, PolicyType payload, UpdatePolicyTypesHeaders headers) returns PolicyType|error

Update PolicyType

Parameters

policyType string - The policy type key field

payload PolicyType - The request body

headers UpdatePolicyTypesHeaders (default {}) - Headers to be sent with the request

Return Type

PolicyType|error - PolicyType updated

listProcessStages

Isolated FunctionRemote Function

function listProcessStages(map<string|string[]> headers, *ListProcessStagesQueries queries) returns ProcessStagesCollection|error

List ProcessStages

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListProcessStagesQueries - Queries to be sent with the request

Return Type

ProcessStagesCollection|error - Collection of ProcessStage

createProcessStages

Isolated FunctionRemote Function

function createProcessStages(ProcessStage payload, map<string|string[]> headers) returns ProcessStage|error

Create ProcessStage

Parameters

payload ProcessStage - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProcessStage|error - ProcessStage created

getProcessStages

Isolated FunctionRemote Function

function getProcessStages(string dataAreaId, string processType, string name, map<string|string[]> headers, *GetProcessStagesQueries queries) returns ProcessStage|error

Get ProcessStage by key

Parameters

dataAreaId string - The company data area identifier

processType string - The process type key field

name string - The name key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetProcessStagesQueries - Queries to be sent with the request

Return Type

ProcessStage|error - ProcessStage

deleteProcessStages

Isolated FunctionRemote Function

function deleteProcessStages(string dataAreaId, string processType, string name, DeleteProcessStagesHeaders headers) returns error?

Delete ProcessStage

Parameters

dataAreaId string - The company data area identifier

processType string - The process type key field

name string - The name key field

headers DeleteProcessStagesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - ProcessStage deleted

updateProcessStages

Isolated FunctionRemote Function

function updateProcessStages(string dataAreaId, string processType, string name, ProcessStage payload, UpdateProcessStagesHeaders headers) returns ProcessStage|error

Update ProcessStage

Parameters

dataAreaId string - The company data area identifier

processType string - The process type key field

name string - The name key field

payload ProcessStage - The request body

headers UpdateProcessStagesHeaders (default {}) - Headers to be sent with the request

Return Type

ProcessStage|error - ProcessStage updated

listRecSetupBases

Isolated FunctionRemote Function

function listRecSetupBases(map<string|string[]> headers, *ListRecSetupBasesQueries queries) returns RecSetupBasesCollection|error

List RecSetupBases

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListRecSetupBasesQueries - Queries to be sent with the request

Return Type

RecSetupBasesCollection|error - Collection of RecSetupBasis

createRecSetupBases

Isolated FunctionRemote Function

function createRecSetupBases(RecSetupBasis payload, map<string|string[]> headers) returns RecSetupBasis|error

Create RecSetupBasis

Parameters

payload RecSetupBasis - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RecSetupBasis|error - RecSetupBasis created

getRecSetupBases

Isolated FunctionRemote Function

function getRecSetupBases(string dataAreaId, string itemId, string itemGroup, map<string|string[]> headers, *GetRecSetupBasesQueries queries) returns RecSetupBasis|error

Get RecSetupBasis by key

Parameters

dataAreaId string - The company data area identifier

itemId string - The item id key field

itemGroup string - The item group key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetRecSetupBasesQueries - Queries to be sent with the request

Return Type

RecSetupBasis|error - RecSetupBasis

deleteRecSetupBases

Isolated FunctionRemote Function

function deleteRecSetupBases(string dataAreaId, string itemId, string itemGroup, DeleteRecSetupBasesHeaders headers) returns error?

Delete RecSetupBasis

Parameters

dataAreaId string - The company data area identifier

itemId string - The item id key field

itemGroup string - The item group key field

headers DeleteRecSetupBasesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - RecSetupBasis deleted

updateRecSetupBases

Isolated FunctionRemote Function

function updateRecSetupBases(string dataAreaId, string itemId, string itemGroup, RecSetupBasis payload, UpdateRecSetupBasesHeaders headers) returns RecSetupBasis|error

Update RecSetupBasis

Parameters

dataAreaId string - The company data area identifier

itemId string - The item id key field

itemGroup string - The item group key field

payload RecSetupBasis - The request body

headers UpdateRecSetupBasesHeaders (default {}) - Headers to be sent with the request

Return Type

RecSetupBasis|error - RecSetupBasis updated

listWorkflows

Isolated FunctionRemote Function

function listWorkflows(map<string|string[]> headers, *ListWorkflowsQueries queries) returns WorkflowsCollection|error

List Workflows

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListWorkflowsQueries - Queries to be sent with the request

Return Type

WorkflowsCollection|error - Collection of Workflow

createWorkflows

Isolated FunctionRemote Function

function createWorkflows(Workflow payload, map<string|string[]> headers) returns Workflow|error

Create Workflow

Parameters

payload Workflow - The request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Workflow|error - Workflow created

getWorkflows

Isolated FunctionRemote Function

function getWorkflows(string sequenceNumber, map<string|string[]> headers, *GetWorkflowsQueries queries) returns Workflow|error

Get Workflow by key

Parameters

sequenceNumber string - The sequence number key field

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetWorkflowsQueries - Queries to be sent with the request

Return Type

Workflow|error - Workflow

deleteWorkflows

Isolated FunctionRemote Function

function deleteWorkflows(string sequenceNumber, DeleteWorkflowsHeaders headers) returns error?

Delete Workflow

Parameters

sequenceNumber string - The sequence number key field

headers DeleteWorkflowsHeaders (default {}) - Headers to be sent with the request

Return Type

error? - Workflow deleted

updateWorkflows

Isolated FunctionRemote Function

function updateWorkflows(string sequenceNumber, Workflow payload, UpdateWorkflowsHeaders headers) returns Workflow|error

Update Workflow

Parameters

sequenceNumber string - The sequence number key field

payload Workflow - The request body

headers UpdateWorkflowsHeaders (default {}) - Headers to be sent with the request

Return Type

Workflow|error - Workflow updated

Records

microsoft.dynamics365.finance.workflow: Action

Fields

numberOfMessageItemsPerExport? Signed32 -

action? string -

splitEROutputByItems? NoYes -

description? string -

actionType? EMActionType -

executableClass? string -

attachToSourceDocument? NoYes -

webService? string -

filenameToProcess? string -

actionPopulateRecord? string -

filename? string -

itemsContentCompressionType? EMCompressionType -

confirmationText? string -

eRFormatMappingGUID? string -

dataAreaId? string -

messageItemType? string -

eRShowDialog? NoYes -

hideActionClassParameters? NoYes -

useERSource? NoYes -

eRModelMappingGUID? string -

microsoft.dynamics365.finance.workflow: ActionClass

Fields

dataAreaId? string -

description? string -

actionType? EMActionType -

executableClass? string -

className? string -

microsoft.dynamics365.finance.workflow: ActionClassesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ActionClassesCollectionAllOf2

value ActionClass[]
anydata...

microsoft.dynamics365.finance.workflow: ActionClassesCollectionAllOf2

Fields

value? ActionClass[] -

microsoft.dynamics365.finance.workflow: ActionsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ActionsCollectionAllOf2

value Action[]
anydata...

microsoft.dynamics365.finance.workflow: ActionsCollectionAllOf2

Fields

value? Action[] -

microsoft.dynamics365.finance.workflow: AdvancedRule

Fields

status? DimensionHierarchyConstraintStatus -

accountStructure? string -

description? string -

advancedRuleName? string -

ruleType? DimensionRuleType -

advancedRuleStructure2? string -

advancedRuleStructure1? string -

advancedRuleStructure4? string -

advancedRuleStructure3? string -

microsoft.dynamics365.finance.workflow: AdvancedRulesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AdvancedRulesCollectionAllOf2

value AdvancedRule[]
anydata...

microsoft.dynamics365.finance.workflow: AdvancedRulesCollectionAllOf2

Fields

value? AdvancedRule[] -

microsoft.dynamics365.finance.workflow: ApprovalUser

Fields

userCompany? string -

userName? string -

userId? string -

userObjectId? string -

microsoft.dynamics365.finance.workflow: ApprovalUsersCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ApprovalUsersCollectionAllOf2

value ApprovalUser[]
anydata...

microsoft.dynamics365.finance.workflow: ApprovalUsersCollectionAllOf2

Fields

value? ApprovalUser[] -

microsoft.dynamics365.finance.workflow: BatchGroup

Fields

serverId? string -

description? string -

groupId? string -

microsoft.dynamics365.finance.workflow: BatchGroupsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *BatchGroupsCollectionAllOf2

value BatchGroup[]
anydata...

microsoft.dynamics365.finance.workflow: BatchGroupsCollectionAllOf2

Fields

value? BatchGroup[] -

microsoft.dynamics365.finance.workflow: BatchJob

Fields

status? BatchStatus -

recurrence? record { fileContent byte[], fileName string } -

executingBy? string -

companyAccounts? string -

startTime? Signed32 -

batchJobRecId? int -

startDate? string -

saveJobToHistory? BatchLogLevel -

startDateTime? string -

jobDescription? string -

origStartDateTime? string -

endDateTime? string -

runtimeJob? boolean -

partitionKey? string -

canceledBy? string -

finishing? Signed32 -

microsoft.dynamics365.finance.workflow: BatchJobsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *BatchJobsCollectionAllOf2

value BatchJob[]
anydata...

microsoft.dynamics365.finance.workflow: BatchJobsCollectionAllOf2

Fields

value? BatchJob[] -

microsoft.dynamics365.finance.workflow: ConnectionConfig

Closed record

Fields

auth? OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - 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

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - 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

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

microsoft.dynamics365.finance.workflow: DatabaseLog

Fields

description? string -

logRecId? int -

newData? string -

logType? DatabaseLogType -

tableIdNumber? Signed32 -

data? record { fileContent byte[], fileName string } -

logDataAreaId? string -

dataAreaId? string -

tableName? string -

tableRecVersion? Signed32 -

logCreatedBy? string -

username? string -

logPartition? int -

sequenceNumber? int -

tableRecId? int -

logCreatedDateTime? string -

logCreatedTransactionId? int -

formattedData? string -

microsoft.dynamics365.finance.workflow: DatabaseLogsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *DatabaseLogsCollectionAllOf2

value DatabaseLog[]
anydata...

microsoft.dynamics365.finance.workflow: DatabaseLogsCollectionAllOf2

Fields

value? DatabaseLog[] -

microsoft.dynamics365.finance.workflow: DeleteActionClassesHeaders

Represents the Headers record for the operation: deleteActionClasses

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteActionsHeaders

Represents the Headers record for the operation: deleteActions

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteAdvancedRulesHeaders

Represents the Headers record for the operation: deleteAdvancedRules

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteApprovalUsersHeaders

Represents the Headers record for the operation: deleteApprovalUsers

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteBatchGroupsHeaders

Represents the Headers record for the operation: deleteBatchGroups

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteBatchJobsHeaders

Represents the Headers record for the operation: deleteBatchJobs

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteDatabaseLogsHeaders

Represents the Headers record for the operation: deleteDatabaseLogs

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteOperationsHeaders

Represents the Headers record for the operation: deleteOperations

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeletePolicyRulesHeaders

Represents the Headers record for the operation: deletePolicyRules

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeletePolicyTypesHeaders

Represents the Headers record for the operation: deletePolicyTypes

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteProcessStagesHeaders

Represents the Headers record for the operation: deleteProcessStages

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteRecSetupBasesHeaders

Represents the Headers record for the operation: deleteRecSetupBases

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: DeleteWorkflowsHeaders

Represents the Headers record for the operation: deleteWorkflows

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: GetActionClassesQueries

Represents the Queries record for the operation: getActionClasses

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetActionsQueries

Represents the Queries record for the operation: getActions

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetAdvancedRulesQueries

Represents the Queries record for the operation: getAdvancedRules

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetApprovalUsersQueries

Represents the Queries record for the operation: getApprovalUsers

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetBatchGroupsQueries

Represents the Queries record for the operation: getBatchGroups

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetBatchJobsQueries

Represents the Queries record for the operation: getBatchJobs

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetDatabaseLogsQueries

Represents the Queries record for the operation: getDatabaseLogs

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetOperationsQueries

Represents the Queries record for the operation: getOperations

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetPolicyRulesQueries

Represents the Queries record for the operation: getPolicyRules

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetPolicyTypesQueries

Represents the Queries record for the operation: getPolicyTypes

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetProcessStagesQueries

Represents the Queries record for the operation: getProcessStages

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetRecSetupBasesQueries

Represents the Queries record for the operation: getRecSetupBases

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: GetWorkflowsQueries

Represents the Queries record for the operation: getWorkflows

Fields

expand? string - OData $expand query parameter - comma-separated list of related entities to include

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: Intrastat

Fields

quarter? QuarterOfYear -

invoice? string -

correctionYear? Signed32 -

categoryHierarchyName? string -

port? string -

itemType? IntrastatItemTypeIT -

countyOfOrigin? string -

stateOfOrigin? string -

netWeightByUnit? decimal -

intrastatStatisticalAdjustmentAmount? decimal -

taxExemptNumber? string -

referenceTableID? Signed32 -

fulfillmentDate? string -

originalIntrastatRecord? string -

relation? Signed32 -

currencyCode? string -

dataAreaId? string -

chargesPercentage? decimal -

nGPCode? Signed32 -

month? MonthsOfYear -

container? NoYes -

statisticsProcedure? string -

sequenceNumber? Signed32 -

transactionCode? string -

statusTrans? Signed32 -

shipmentBatch? string -

compress? NoYes -

log? string -

miscChargePerKg? decimal -

stateSenderReceiver? string -

weight? decimal -

statisticalAmount? decimal -

preference? Signed32 -

state? string -

paymentMethod? IntrastatPaymentMethodIT -

deliveryMode? string -

invoiceChargesAmountTransCurrency? decimal -

identificationOfThePackingSlipOrProductReceipt? string -

countryRegionSenderReceiver? string -

transport? string -

'module? ModuleInventCustVend -

consignments? Signed32 -

intrastatStatisticalValue? decimal -

deliverySchedule? IntrastatServicesDeliveryIT -

description? string -

tariffNumber? Signed32 -

invoiceChargesAmount? decimal -

nGPDescription? string -

invoiceAmount? decimal -

commodityAdditionalUnits? string -

correction? NoYes -

sendReceiveState? string -

commodityHierarchyName? string -

direction? IntrastatDirection -

county? string -

additionalUnit? string -

itemNumber? string -

origCountryRegionId? string -

commodity? string -

specialMovement? string -

number? string -

invoiceAmountTransCur? decimal -

statisticalChargesAmount? decimal -

statementNumber? string -

deliveryTerms? string -

intrastatOrderType? IntrastatOrderType -

amount? decimal -

additionalUnitsQuantity? decimal -

quantity? decimal -

chargesAmount? decimal -

parentCommodityName? string -

partialConsignment? NoYes -

directionCode? string -

date? string -

accountNumber? string -

lotID? string -

taxRegistrationNumber? string -

customsCode? string -

countryRegionId? string -

parentCommodity? string -

categoryName? string -

commodityName? string -

currentAgreement? NoYes -

microsoft.dynamics365.finance.workflow: ListActionClassesQueries

Represents the Queries record for the operation: listActionClasses

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListActionsQueries

Represents the Queries record for the operation: listActions

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListAdvancedRulesQueries

Represents the Queries record for the operation: listAdvancedRules

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListApprovalUsersQueries

Represents the Queries record for the operation: listApprovalUsers

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListBatchGroupsQueries

Represents the Queries record for the operation: listBatchGroups

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListBatchJobsQueries

Represents the Queries record for the operation: listBatchJobs

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListDatabaseLogsQueries

Represents the Queries record for the operation: listDatabaseLogs

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListOperationsQueries

Represents the Queries record for the operation: listOperations

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListPolicyRulesQueries

Represents the Queries record for the operation: listPolicyRules

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListPolicyTypesQueries

Represents the Queries record for the operation: listPolicyTypes

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListProcessStagesQueries

Represents the Queries record for the operation: listProcessStages

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListRecSetupBasesQueries

Represents the Queries record for the operation: listRecSetupBases

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: ListWorkflowsQueries

Represents the Queries record for the operation: listWorkflows

Fields

skip? int - OData $skip query parameter - number of records to skip

top? int - OData $top query parameter - maximum number of records to return

filter? string - OData $filter query parameter - filter expression

orderby? string - OData $orderby query parameter - sort order expression

expand? string - OData $expand query parameter - comma-separated list of related entities to include

crossCompany? boolean - When true, query results include records from all companies

count? boolean - When true, the response includes the total count of matching records

'select? string - OData $select query parameter - comma-separated list of fields to return

microsoft.dynamics365.finance.workflow: NGPCode

Fields

dataAreaId? string -

description? string -

nGP? Signed32 -

microsoft.dynamics365.finance.workflow: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields

Fields Included from *OAuth2ClientCredentialsGrantConfig

tokenUrl string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

tokenUrl string(default "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token") - Token URL

microsoft.dynamics365.finance.workflow: ODataCollection

Fields

odataNextLink? string -

odataCount? int -

odataContext? string -

microsoft.dynamics365.finance.workflow: Operation

Fields

dataAreaId? string -

operationName? string -

operationId? string -

microsoft.dynamics365.finance.workflow: OperationsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *OperationsCollectionAllOf2

value Operation[]
anydata...

microsoft.dynamics365.finance.workflow: OperationsCollectionAllOf2

Fields

value? Operation[] -

microsoft.dynamics365.finance.workflow: PolicyRule

Fields

policyType? SysPolicyTypeEnum -

action? TrvPolicyViolationLevel -

validTo? string -

policyName? string -

validFrom? string -

includeParentRule? NoYes -

policyRuleName? string -

expressionId? string -

microsoft.dynamics365.finance.workflow: PolicyRulesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *PolicyRulesCollectionAllOf2

value PolicyRule[]
anydata...

microsoft.dynamics365.finance.workflow: PolicyRulesCollectionAllOf2

Fields

value? PolicyRule[] -

microsoft.dynamics365.finance.workflow: PolicyType

Fields

policyType? SysPolicyTypeEnum -

dropDialog? NoYes -

isPolicyReadOnly? NoYes -

policyName? string -

isReassignOrganizationSupported? NoYes -

purpose? HierarchyPurpose -

microsoft.dynamics365.finance.workflow: PolicyTypesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *PolicyTypesCollectionAllOf2

value PolicyType[]
anydata...

microsoft.dynamics365.finance.workflow: PolicyTypesCollectionAllOf2

Fields

value? PolicyType[] -

microsoft.dynamics365.finance.workflow: ProcessStage

Fields

dataAreaId? string -

processType? BusinessProcessType -

description? string -

sequenceNumber? decimal -

name? string -

microsoft.dynamics365.finance.workflow: ProcessStagesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ProcessStagesCollectionAllOf2

value ProcessStage[]
anydata...

microsoft.dynamics365.finance.workflow: ProcessStagesCollectionAllOf2

Fields

value? ProcessStage[] -

microsoft.dynamics365.finance.workflow: RecSetupBasesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *RecSetupBasesCollectionAllOf2

value RecSetupBasis[]
anydata...

microsoft.dynamics365.finance.workflow: RecSetupBasesCollectionAllOf2

Fields

value? RecSetupBasis[] -

microsoft.dynamics365.finance.workflow: RecSetupBasis

Fields

dataAreaId? string -

itemGroup? string -

description? string -

itemId? string -

microsoft.dynamics365.finance.workflow: Type

Fields

dataAreaId? string -

shortName? string -

flTypeId? string -

name? string -

microsoft.dynamics365.finance.workflow: UpdateActionClassesHeaders

Represents the Headers record for the operation: updateActionClasses

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateActionsHeaders

Represents the Headers record for the operation: updateActions

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateAdvancedRulesHeaders

Represents the Headers record for the operation: updateAdvancedRules

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateApprovalUsersHeaders

Represents the Headers record for the operation: updateApprovalUsers

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateBatchGroupsHeaders

Represents the Headers record for the operation: updateBatchGroups

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateBatchJobsHeaders

Represents the Headers record for the operation: updateBatchJobs

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateDatabaseLogsHeaders

Represents the Headers record for the operation: updateDatabaseLogs

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateOperationsHeaders

Represents the Headers record for the operation: updateOperations

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdatePolicyRulesHeaders

Represents the Headers record for the operation: updatePolicyRules

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdatePolicyTypesHeaders

Represents the Headers record for the operation: updatePolicyTypes

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateProcessStagesHeaders

Represents the Headers record for the operation: updateProcessStages

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateRecSetupBasesHeaders

Represents the Headers record for the operation: updateRecSetupBases

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: UpdateWorkflowsHeaders

Represents the Headers record for the operation: updateWorkflows

Fields

ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications

microsoft.dynamics365.finance.workflow: WebService

Fields

webApplicationName? string -

internetAddress? string -

additionalSuccessfulResponseCodes? string -

description? string -

webService? string -

signXMLUriFormat? string -

sOAPPathResponse? string -

requestTypeXML? NoYes -

requestMethod? string -

sOAPPatternRequest? string -

signXML? NoYes -

sOAPEnvelope? NoYes -

signXMLUseRSA256? NoYes -

signXMLUriPath? string -

requestHeadersFormatMappingGUID? string -

requestAccept? string -

dataAreaId? string -

signXMLPath? string -

sOAPPathRequest? string -

useAdvancedParameters? NoYes -

successfulResponseCode? Signed32 -

requestContentType? string -

requestHeaders? string -

requestAcceptEncoding? string -

microsoft.dynamics365.finance.workflow: Workflow

Fields

'type? WorkflowConfigurationType -

dataArea? string -

associationType? WorkflowAssociationType -

documentTableName? string -

sequenceNumber? string -

categoryName? string -

templateName? string -

defaultConfiguration? NoYes -

'module? ModuleAxapta -

name? string -

microsoft.dynamics365.finance.workflow: WorkflowsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *WorkflowsCollectionAllOf2

value Workflow[]
anydata...

microsoft.dynamics365.finance.workflow: WorkflowsCollectionAllOf2

Fields

value? Workflow[] -

Union types

microsoft.dynamics365.finance.workflow: IntrastatOrderType

"Order"|"Correction"|"Return"

IntrastatOrderType

microsoft.dynamics365.finance.workflow: EMCompressionType

"None"|"GZIP"

EMCompressionType

microsoft.dynamics365.finance.workflow: IntrastatServicesDeliveryIT

"None"|"SingleDelivery"|"MultipleDeliveries"

IntrastatServicesDeliveryIT

microsoft.dynamics365.finance.workflow: WorkflowAssociationType

"Company"|"Global"|"Other"

WorkflowAssociationType

microsoft.dynamics365.finance.workflow: BusinessProcessType

"Generic"|"Onboarding"|"Offboarding"|"Transitions"

BusinessProcessType

microsoft.dynamics365.finance.workflow: BatchStatus

BatchStatus

microsoft.dynamics365.finance.workflow: EMActionType

EMActionType

microsoft.dynamics365.finance.workflow: WorkflowConfigurationType

"Definition"|"InProcess"

WorkflowConfigurationType

microsoft.dynamics365.finance.workflow: ModuleInventCustVend

"Invent"|"Cust"|"Vend"

ModuleInventCustVend

microsoft.dynamics365.finance.workflow: IntrastatPaymentMethodIT

"Other"|"BillOfExchange"|"PromissoryNote"

IntrastatPaymentMethodIT

microsoft.dynamics365.finance.workflow: MonthsOfYear

MonthsOfYear

microsoft.dynamics365.finance.workflow: QuarterOfYear

"None"|"Q1"|"Q2"|"Q3"|"Q4"

QuarterOfYear

microsoft.dynamics365.finance.workflow: SysPolicyTypeEnum

SysPolicyTypeEnum

microsoft.dynamics365.finance.workflow: IntrastatDirection

"Import"|"Export"

IntrastatDirection

microsoft.dynamics365.finance.workflow: TrvPolicyViolationLevel

TrvPolicyViolationLevel

microsoft.dynamics365.finance.workflow: ModuleAxapta

ModuleAxapta

microsoft.dynamics365.finance.workflow: BatchLogLevel

"Always"|"Error"|"Never"

BatchLogLevel

microsoft.dynamics365.finance.workflow: HierarchyPurpose

HierarchyPurpose

microsoft.dynamics365.finance.workflow: IntrastatItemTypeIT

"Goods"|"Services"

IntrastatItemTypeIT

microsoft.dynamics365.finance.workflow: DimensionHierarchyConstraintStatus

"Draft"|"Active"|"Activating"

DimensionHierarchyConstraintStatus

microsoft.dynamics365.finance.workflow: NoYes

"No"|"Yes"

NoYes

microsoft.dynamics365.finance.workflow: DimensionRuleType

"GeneralLedger"|"BudgetPlanning"

DimensionRuleType

microsoft.dynamics365.finance.workflow: DatabaseLogType

DatabaseLogType

Import

import ballerinax/microsoft.dynamics365.finance.workflow;

Other versions

0.8.0

Metadata

Released date: 1 day ago

Version: 0.8.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Name/Microsoft Dynamics 365 Finance Workflow

Area/System

Vendor/Microsoft

Dynamics365

Finance

ERP

Type/Connector

Workflow

Batch

Automation

Policy

Contributors

Dependencies

ballerina/data.jsondata/1.1.3 ballerina/url/2.6.1 ballerina/http/2.16.3

Cookie policy

Delete policy

clients

records

unionTypes

ballerinax/microsoft.dynamics365.finance.workflow Ballerina library

Overview

Key Features

Setup guide

Prerequisites

Step 1: Register an application in Azure AD

Step 2: Grant Dynamics 365 API permissions

Step 3: Add the app as a D365 user

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Step 4: Run the Ballerina application

Examples

Clients

microsoft.dynamics365.finance.workflow: Client

Constructor

listActionClasses

Parameters

Return Type

createActionClasses

Parameters

Return Type

getActionClasses

Parameters

Return Type

deleteActionClasses

Parameters

Return Type

updateActionClasses

Parameters

Return Type

listActions

Parameters

Return Type

createActions

Parameters

Return Type

getActions

Parameters

Return Type

deleteActions

Parameters

Return Type

updateActions

Parameters

Return Type

listAdvancedRules

Parameters

Return Type

createAdvancedRules

Parameters

Return Type

getAdvancedRules

Parameters

Return Type

deleteAdvancedRules

Parameters

Return Type

updateAdvancedRules

Parameters

Return Type

listApprovalUsers

Parameters

Return Type

createApprovalUsers

Parameters

Return Type

getApprovalUsers

Parameters

Return Type

deleteApprovalUsers

Parameters

Return Type

updateApprovalUsers

Parameters

Return Type