Module microsoft.dynamics365.finance.document

ballerinax/microsoft.dynamics365.finance.document 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.document connector provides access to Microsoft Dynamics 365 Finance Document entities via the OData REST API.

Key Features

Manage document 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.document connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/microsoft.dynamics365.finance.document;

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"

document: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


document:AgentFeedsCollection results = check cl->listAgentFeeds();

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.document: 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

listAgentFeeds

Isolated FunctionRemote Function

function listAgentFeeds(map<string|string[]> headers, *ListAgentFeedsQueries queries) returns AgentFeedsCollection|error

List AgentFeeds

Parameters

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

queries *ListAgentFeedsQueries - Queries to be sent with the request

Return Type

AgentFeedsCollection|error - Collection of AgentFeed

createAgentFeeds

Isolated FunctionRemote Function

function createAgentFeeds(AgentFeed payload, map<string|string[]> headers) returns AgentFeed|error

Create AgentFeed

Parameters

payload AgentFeed - The request body

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

Return Type

AgentFeed|error - AgentFeed created

getAgentFeeds

Isolated FunctionRemote Function

function getAgentFeeds(string feedItemId, string correlationId, map<string|string[]> headers, *GetAgentFeedsQueries queries) returns AgentFeed|error

Get AgentFeed by key

Parameters

feedItemId string - The feed item id key field

correlationId string - The correlation id key field

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

queries *GetAgentFeedsQueries - Queries to be sent with the request

Return Type

AgentFeed|error - AgentFeed

deleteAgentFeeds

Isolated FunctionRemote Function

function deleteAgentFeeds(string feedItemId, string correlationId, DeleteAgentFeedsHeaders headers) returns error?

Delete AgentFeed

Parameters

feedItemId string - The feed item id key field

correlationId string - The correlation id key field

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

Return Type

error? - AgentFeed deleted

updateAgentFeeds

Isolated FunctionRemote Function

function updateAgentFeeds(string feedItemId, string correlationId, AgentFeed payload, UpdateAgentFeedsHeaders headers) returns AgentFeed|error

Update AgentFeed

Parameters

feedItemId string - The feed item id key field

correlationId string - The correlation id key field

payload AgentFeed - The request body

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

Return Type

AgentFeed|error - AgentFeed updated

listAgents

Isolated FunctionRemote Function

function listAgents(map<string|string[]> headers, *ListAgentsQueries queries) returns AgentsCollection|error

List Agents

Parameters

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

queries *ListAgentsQueries - Queries to be sent with the request

Return Type

AgentsCollection|error - Collection of Agent

createAgents

Isolated FunctionRemote Function

function createAgents(Agent payload, map<string|string[]> headers) returns Agent|error

Create Agent

Parameters

payload Agent - The request body

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

Return Type

Agent|error - Agent created

getAgents

Isolated FunctionRemote Function

function getAgents(string dataAreaId, string agentId, map<string|string[]> headers, *GetAgentsQueries queries) returns Agent|error

Get Agent by key

Parameters

dataAreaId string - The company data area identifier

agentId string - The agent id key field

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

queries *GetAgentsQueries - Queries to be sent with the request

Return Type

Agent|error - Agent

deleteAgents

Isolated FunctionRemote Function

function deleteAgents(string dataAreaId, string agentId, DeleteAgentsHeaders headers) returns error?

Delete Agent

Parameters

dataAreaId string - The company data area identifier

agentId string - The agent id key field

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

Return Type

error? - Agent deleted

updateAgents

Isolated FunctionRemote Function

function updateAgents(string dataAreaId, string agentId, Agent payload, UpdateAgentsHeaders headers) returns Agent|error

Update Agent

Parameters

dataAreaId string - The company data area identifier

agentId string - The agent id key field

payload Agent - The request body

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

Return Type

Agent|error - Agent updated

listDemoDataPosts

Isolated FunctionRemote Function

function listDemoDataPosts(map<string|string[]> headers, *ListDemoDataPostsQueries queries) returns DemoDataPostsCollection|error

List DemoDataPosts

Parameters

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

queries *ListDemoDataPostsQueries - Queries to be sent with the request

Return Type

DemoDataPostsCollection|error - Collection of DemoDataPost

createDemoDataPosts

Isolated FunctionRemote Function

function createDemoDataPosts(DemoDataPost payload, map<string|string[]> headers) returns DemoDataPost|error

Create DemoDataPost

Parameters

payload DemoDataPost - The request body

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

Return Type

DemoDataPost|error - DemoDataPost created

getDemoDataPosts

Isolated FunctionRemote Function

function getDemoDataPosts(string dataAreaId, string demoDataJob, decimal lineNum, map<string|string[]> headers, *GetDemoDataPostsQueries queries) returns DemoDataPost|error

Get DemoDataPost by key

Parameters

dataAreaId string - The company data area identifier

demoDataJob string - The demo data job key field

lineNum decimal - The line num key field

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

queries *GetDemoDataPostsQueries - Queries to be sent with the request

Return Type

DemoDataPost|error - DemoDataPost

deleteDemoDataPosts

Isolated FunctionRemote Function

function deleteDemoDataPosts(string dataAreaId, string demoDataJob, decimal lineNum, DeleteDemoDataPostsHeaders headers) returns error?

Delete DemoDataPost

Parameters

dataAreaId string - The company data area identifier

demoDataJob string - The demo data job key field

lineNum decimal - The line num key field

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

Return Type

error? - DemoDataPost deleted

updateDemoDataPosts

Isolated FunctionRemote Function

function updateDemoDataPosts(string dataAreaId, string demoDataJob, decimal lineNum, DemoDataPost payload, UpdateDemoDataPostsHeaders headers) returns DemoDataPost|error

Update DemoDataPost

Parameters

dataAreaId string - The company data area identifier

demoDataJob string - The demo data job key field

lineNum decimal - The line num key field

payload DemoDataPost - The request body

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

Return Type

DemoDataPost|error - DemoDataPost updated

listDocumentTypes

Isolated FunctionRemote Function

function listDocumentTypes(map<string|string[]> headers, *ListDocumentTypesQueries queries) returns DocumentTypesCollection|error

List DocumentTypes

Parameters

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

queries *ListDocumentTypesQueries - Queries to be sent with the request

Return Type

DocumentTypesCollection|error - Collection of DocumentType

createDocumentTypes

Isolated FunctionRemote Function

function createDocumentTypes(DocumentType payload, map<string|string[]> headers) returns DocumentType|error

Create DocumentType

Parameters

payload DocumentType - The request body

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

Return Type

DocumentType|error - DocumentType created

getDocumentTypes

Isolated FunctionRemote Function

function getDocumentTypes(string dataAreaId, string iD, map<string|string[]> headers, *GetDocumentTypesQueries queries) returns DocumentType|error

Get DocumentType by key

Parameters

dataAreaId string - The company data area identifier

iD string - The i d key field

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

queries *GetDocumentTypesQueries - Queries to be sent with the request

Return Type

DocumentType|error - DocumentType

deleteDocumentTypes

Isolated FunctionRemote Function

function deleteDocumentTypes(string dataAreaId, string iD, DeleteDocumentTypesHeaders headers) returns error?

Delete DocumentType

Parameters

dataAreaId string - The company data area identifier

iD string - The i d key field

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

Return Type

error? - DocumentType deleted

updateDocumentTypes

Isolated FunctionRemote Function

function updateDocumentTypes(string dataAreaId, string iD, DocumentType payload, UpdateDocumentTypesHeaders headers) returns DocumentType|error

Update DocumentType

Parameters

dataAreaId string - The company data area identifier

iD string - The i d key field

payload DocumentType - The request body

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

Return Type

DocumentType|error - DocumentType updated

listDocuments

Isolated FunctionRemote Function

function listDocuments(map<string|string[]> headers, *ListDocumentsQueries queries) returns DocumentsCollection|error

List Documents

Parameters

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

queries *ListDocumentsQueries - Queries to be sent with the request

Return Type

DocumentsCollection|error - Collection of Document

createDocuments

Isolated FunctionRemote Function

function createDocuments(Document payload, map<string|string[]> headers) returns Document|error

Create Document

Parameters

payload Document - The request body

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

Return Type

Document|error - Document created

getDocuments

Isolated FunctionRemote Function

function getDocuments(string dataAreaId, string lineId, map<string|string[]> headers, *GetDocumentsQueries queries) returns Document|error

Get Document by key

Parameters

dataAreaId string - The company data area identifier

lineId string - The line id key field

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

queries *GetDocumentsQueries - Queries to be sent with the request

Return Type

Document|error - Document

deleteDocuments

Isolated FunctionRemote Function

function deleteDocuments(string dataAreaId, string lineId, DeleteDocumentsHeaders headers) returns error?

Delete Document

Parameters

dataAreaId string - The company data area identifier

lineId string - The line id key field

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

Return Type

error? - Document deleted

updateDocuments

Isolated FunctionRemote Function

function updateDocuments(string dataAreaId, string lineId, Document payload, UpdateDocumentsHeaders headers) returns Document|error

Update Document

Parameters

dataAreaId string - The company data area identifier

lineId string - The line id key field

payload Document - The request body

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

Return Type

Document|error - Document updated

listEDParameters

Isolated FunctionRemote Function

function listEDParameters(map<string|string[]> headers, *ListEDParametersQueries queries) returns EDParametersCollection|error

List EDParameters

Parameters

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

queries *ListEDParametersQueries - Queries to be sent with the request

Return Type

EDParametersCollection|error - Collection of EDParameter

createEDParameters

Isolated FunctionRemote Function

function createEDParameters(EDParameter payload, map<string|string[]> headers) returns EDParameter|error

Create EDParameter

Parameters

payload EDParameter - The request body

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

Return Type

EDParameter|error - EDParameter created

getEDParameters

Isolated FunctionRemote Function

function getEDParameters(string dataAreaId, int 'key, map<string|string[]> headers, *GetEDParametersQueries queries) returns EDParameter|error

Get EDParameter by key

Parameters

dataAreaId string - The company data area identifier

'key int - The entity key value

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

queries *GetEDParametersQueries - Queries to be sent with the request

Return Type

EDParameter|error - EDParameter

deleteEDParameters

Isolated FunctionRemote Function

function deleteEDParameters(string dataAreaId, int 'key, DeleteEDParametersHeaders headers) returns error?

Delete EDParameter

Parameters

dataAreaId string - The company data area identifier

'key int - The entity key value

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

Return Type

error? - EDParameter deleted

updateEDParameters

Isolated FunctionRemote Function

function updateEDParameters(string dataAreaId, int 'key, EDParameter payload, UpdateEDParametersHeaders headers) returns EDParameter|error

Update EDParameter

Parameters

dataAreaId string - The company data area identifier

'key int - The entity key value

payload EDParameter - The request body

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

Return Type

EDParameter|error - EDParameter updated

listGuides

Isolated FunctionRemote Function

function listGuides(map<string|string[]> headers, *ListGuidesQueries queries) returns GuidesCollection|error

List Guides

Parameters

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

queries *ListGuidesQueries - Queries to be sent with the request

Return Type

GuidesCollection|error - Collection of Guide

createGuides

Isolated FunctionRemote Function

function createGuides(Guide payload, map<string|string[]> headers) returns Guide|error

Create Guide

Parameters

payload Guide - The request body

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

Return Type

Guide|error - Guide created

getGuides

Isolated FunctionRemote Function

function getGuides(string integrationKey, map<string|string[]> headers, *GetGuidesQueries queries) returns Guide|error

Get Guide by key

Parameters

integrationKey string - The integration key key field

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

queries *GetGuidesQueries - Queries to be sent with the request

Return Type

Guide|error - Guide

deleteGuides

Isolated FunctionRemote Function

function deleteGuides(string integrationKey, DeleteGuidesHeaders headers) returns error?

Delete Guide

Parameters

integrationKey string - The integration key key field

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

Return Type

error? - Guide deleted

updateGuides

Isolated FunctionRemote Function

function updateGuides(string integrationKey, Guide payload, UpdateGuidesHeaders headers) returns Guide|error

Update Guide

Parameters

integrationKey string - The integration key key field

payload Guide - The request body

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

Return Type

Guide|error - Guide updated

listMedia

Isolated FunctionRemote Function

function listMedia(map<string|string[]> headers, *ListMediaQueries queries) returns MediaCollection|error

List Media

Parameters

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

queries *ListMediaQueries - Queries to be sent with the request

Return Type

MediaCollection|error - Collection of Media

createMedia

Isolated FunctionRemote Function

function createMedia(Media payload, map<string|string[]> headers) returns Media|error

Create Media

Parameters

payload Media - The request body

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

Return Type

Media|error - Media created

getMedia

Isolated FunctionRemote Function

function getMedia(string dataAreaId, string media, map<string|string[]> headers, *GetMediaQueries queries) returns Media|error

Get Media by key

Parameters

dataAreaId string - The company data area identifier

media string - The media key field

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

queries *GetMediaQueries - Queries to be sent with the request

Return Type

Media|error - Media

deleteMedia

Isolated FunctionRemote Function

function deleteMedia(string dataAreaId, string media, DeleteMediaHeaders headers) returns error?

Delete Media

Parameters

dataAreaId string - The company data area identifier

media string - The media key field

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

Return Type

error? - Media deleted

updateMedia

Isolated FunctionRemote Function

function updateMedia(string dataAreaId, string media, Media payload, UpdateMediaHeaders headers) returns Media|error

Update Media

Parameters

dataAreaId string - The company data area identifier

media string - The media key field

payload Media - The request body

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

Return Type

Media|error - Media updated

listMediaTypes

Isolated FunctionRemote Function

function listMediaTypes(map<string|string[]> headers, *ListMediaTypesQueries queries) returns MediaTypesCollection|error

List MediaTypes

Parameters

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

queries *ListMediaTypesQueries - Queries to be sent with the request

Return Type

MediaTypesCollection|error - Collection of MediaType

createMediaTypes

Isolated FunctionRemote Function

function createMediaTypes(MediaType payload, map<string|string[]> headers) returns MediaType|error

Create MediaType

Parameters

payload MediaType - The request body

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

Return Type

MediaType|error - MediaType created

getMediaTypes

Isolated FunctionRemote Function

function getMediaTypes(string dataAreaId, string mediaTypeId, map<string|string[]> headers, *GetMediaTypesQueries queries) returns MediaType|error

Get MediaType by key

Parameters

dataAreaId string - The company data area identifier

mediaTypeId string - The media type id key field

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

queries *GetMediaTypesQueries - Queries to be sent with the request

Return Type

MediaType|error - MediaType

deleteMediaTypes

Isolated FunctionRemote Function

function deleteMediaTypes(string dataAreaId, string mediaTypeId, DeleteMediaTypesHeaders headers) returns error?

Delete MediaType

Parameters

dataAreaId string - The company data area identifier

mediaTypeId string - The media type id key field

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

Return Type

error? - MediaType deleted

updateMediaTypes

Isolated FunctionRemote Function

function updateMediaTypes(string dataAreaId, string mediaTypeId, MediaType payload, UpdateMediaTypesHeaders headers) returns MediaType|error

Update MediaType

Parameters

dataAreaId string - The company data area identifier

mediaTypeId string - The media type id key field

payload MediaType - The request body

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

Return Type

MediaType|error - MediaType updated

listMessageItems

Isolated FunctionRemote Function

function listMessageItems(map<string|string[]> headers, *ListMessageItemsQueries queries) returns MessageItemsCollection|error

List MessageItems

Parameters

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

queries *ListMessageItemsQueries - Queries to be sent with the request

Return Type

MessageItemsCollection|error - Collection of MessageItems

createMessageItems

Isolated FunctionRemote Function

function createMessageItems(MessageItems payload, map<string|string[]> headers) returns MessageItems|error

Create MessageItems

Parameters

payload MessageItems - The request body

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

Return Type

MessageItems|error - MessageItems created

getMessageItems

Isolated FunctionRemote Function

function getMessageItems(string dataAreaId, string itemId, string itemType, string processingId, map<string|string[]> headers, *GetMessageItemsQueries queries) returns MessageItems|error

Get MessageItems by key

Parameters

dataAreaId string - The company data area identifier

itemId string - The item id key field

itemType string - The item type key field

processingId string - The processing id key field

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

queries *GetMessageItemsQueries - Queries to be sent with the request

Return Type

MessageItems|error - MessageItems

deleteMessageItems

Isolated FunctionRemote Function

function deleteMessageItems(string dataAreaId, string itemId, string itemType, string processingId, DeleteMessageItemsHeaders headers) returns error?

Delete MessageItems

Parameters

dataAreaId string - The company data area identifier

itemId string - The item id key field

itemType string - The item type key field

processingId string - The processing id key field

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

Return Type

error? - MessageItems deleted

updateMessageItems

Isolated FunctionRemote Function

function updateMessageItems(string dataAreaId, string itemId, string itemType, string processingId, MessageItems payload, UpdateMessageItemsHeaders headers) returns MessageItems|error

Update MessageItems

Parameters

dataAreaId string - The company data area identifier

itemId string - The item id key field

itemType string - The item type key field

processingId string - The processing id key field

payload MessageItems - The request body

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

Return Type

MessageItems|error - MessageItems updated

listMessageStatus

Isolated FunctionRemote Function

function listMessageStatus(map<string|string[]> headers, *ListMessageStatusQueries queries) returns MessageStatusCollection|error

List MessageStatus

Parameters

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

queries *ListMessageStatusQueries - Queries to be sent with the request

Return Type

MessageStatusCollection|error - Collection of MessageStatus

createMessageStatus

Isolated FunctionRemote Function

function createMessageStatus(MessageStatus payload, map<string|string[]> headers) returns MessageStatus|error

Create MessageStatus

Parameters

payload MessageStatus - The request body

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

Return Type

MessageStatus|error - MessageStatus created

getMessageStatus

Isolated FunctionRemote Function

function getMessageStatus(string dataAreaId, string messageStatus, map<string|string[]> headers, *GetMessageStatusQueries queries) returns MessageStatus|error

Get MessageStatus by key

Parameters

dataAreaId string - The company data area identifier

messageStatus string - The message status key field

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

queries *GetMessageStatusQueries - Queries to be sent with the request

Return Type

MessageStatus|error - MessageStatus

deleteMessageStatus

Isolated FunctionRemote Function

function deleteMessageStatus(string dataAreaId, string messageStatus, DeleteMessageStatusHeaders headers) returns error?

Delete MessageStatus

Parameters

dataAreaId string - The company data area identifier

messageStatus string - The message status key field

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

Return Type

error? - MessageStatus deleted

updateMessageStatus

Isolated FunctionRemote Function

function updateMessageStatus(string dataAreaId, string messageStatus, MessageStatus payload, UpdateMessageStatusHeaders headers) returns MessageStatus|error

Update MessageStatus

Parameters

dataAreaId string - The company data area identifier

messageStatus string - The message status key field

payload MessageStatus - The request body

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

Return Type

MessageStatus|error - MessageStatus updated

listMessagesLogs

Isolated FunctionRemote Function

function listMessagesLogs(map<string|string[]> headers, *ListMessagesLogsQueries queries) returns MessagesLogsCollection|error

List MessagesLogs

Parameters

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

queries *ListMessagesLogsQueries - Queries to be sent with the request

Return Type

MessagesLogsCollection|error - Collection of MessagesLog

createMessagesLogs

Isolated FunctionRemote Function

function createMessagesLogs(MessagesLog payload, map<string|string[]> headers) returns MessagesLog|error

Create MessagesLog

Parameters

payload MessagesLog - The request body

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

Return Type

MessagesLog|error - MessagesLog created

getMessagesLogs

Isolated FunctionRemote Function

function getMessagesLogs(string dataAreaId, string messageId, string actionId, map<string|string[]> headers, *GetMessagesLogsQueries queries) returns MessagesLog|error

Get MessagesLog by key

Parameters

dataAreaId string - The company data area identifier

messageId string - The message id key field

actionId string - The action id key field

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

queries *GetMessagesLogsQueries - Queries to be sent with the request

Return Type

MessagesLog|error - MessagesLog

deleteMessagesLogs

Isolated FunctionRemote Function

function deleteMessagesLogs(string dataAreaId, string messageId, string actionId, DeleteMessagesLogsHeaders headers) returns error?

Delete MessagesLog

Parameters

dataAreaId string - The company data area identifier

messageId string - The message id key field

actionId string - The action id key field

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

Return Type

error? - MessagesLog deleted

updateMessagesLogs

Isolated FunctionRemote Function

function updateMessagesLogs(string dataAreaId, string messageId, string actionId, MessagesLog payload, UpdateMessagesLogsHeaders headers) returns MessagesLog|error

Update MessagesLog

Parameters

dataAreaId string - The company data area identifier

messageId string - The message id key field

actionId string - The action id key field

payload MessagesLog - The request body

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

Return Type

MessagesLog|error - MessagesLog updated

listPrintLayouts

Isolated FunctionRemote Function

function listPrintLayouts(map<string|string[]> headers, *ListPrintLayoutsQueries queries) returns PrintLayoutsCollection|error

List PrintLayouts

Parameters

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

queries *ListPrintLayoutsQueries - Queries to be sent with the request

Return Type

PrintLayoutsCollection|error - Collection of PrintLayout

createPrintLayouts

Isolated FunctionRemote Function

function createPrintLayouts(PrintLayout payload, map<string|string[]> headers) returns PrintLayout|error

Create PrintLayout

Parameters

payload PrintLayout - The request body

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

Return Type

PrintLayout|error - PrintLayout created

getPrintLayouts

Isolated FunctionRemote Function

function getPrintLayouts(string dataAreaId, string printLayoutGroup, string printLayoutCode, map<string|string[]> headers, *GetPrintLayoutsQueries queries) returns PrintLayout|error

Get PrintLayout by key

Parameters

dataAreaId string - The company data area identifier

printLayoutGroup string - The print layout group key field

printLayoutCode string - The print layout code key field

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

queries *GetPrintLayoutsQueries - Queries to be sent with the request

Return Type

PrintLayout|error - PrintLayout

deletePrintLayouts

Isolated FunctionRemote Function

function deletePrintLayouts(string dataAreaId, string printLayoutGroup, string printLayoutCode, DeletePrintLayoutsHeaders headers) returns error?

Delete PrintLayout

Parameters

dataAreaId string - The company data area identifier

printLayoutGroup string - The print layout group key field

printLayoutCode string - The print layout code key field

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

Return Type

error? - PrintLayout deleted

updatePrintLayouts

Isolated FunctionRemote Function

function updatePrintLayouts(string dataAreaId, string printLayoutGroup, string printLayoutCode, PrintLayout payload, UpdatePrintLayoutsHeaders headers) returns PrintLayout|error

Update PrintLayout

Parameters

dataAreaId string - The company data area identifier

printLayoutGroup string - The print layout group key field

printLayoutCode string - The print layout code key field

payload PrintLayout - The request body

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

Return Type

PrintLayout|error - PrintLayout updated

Records

microsoft.dynamics365.finance.document: Agent

Fields

dataAreaId? string -

partyNumber? string -

taxRegNum? string -

agentId? string -

name? string -

microsoft.dynamics365.finance.document: AgentFeed

Fields

baseRank? decimal -

status? AgentFeedItemStatus -

aIContext? string -

timeToLive? string -

modifiedOn? string -

title? string -

permissionsCheck? string -

feedItemId? string -

feedItemRecId? int -

cardProvider? string -

summary? string -

correlationId? string -

createdOn? string -

dueDate? string -

subTitle? string -

microsoft.dynamics365.finance.document: AgentFeedsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AgentFeedsCollectionAllOf2

value AgentFeed[]
anydata...

microsoft.dynamics365.finance.document: AgentFeedsCollectionAllOf2

Fields

value? AgentFeed[] -

microsoft.dynamics365.finance.document: AgentsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AgentsCollectionAllOf2

value Agent[]
anydata...

microsoft.dynamics365.finance.document: AgentsCollectionAllOf2

Fields

value? Agent[] -

microsoft.dynamics365.finance.document: 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.document: DeleteAgentFeedsHeaders

Represents the Headers record for the operation: deleteAgentFeeds

Fields

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

microsoft.dynamics365.finance.document: DeleteAgentsHeaders

Represents the Headers record for the operation: deleteAgents

Fields

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

microsoft.dynamics365.finance.document: DeleteDemoDataPostsHeaders

Represents the Headers record for the operation: deleteDemoDataPosts

Fields

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

microsoft.dynamics365.finance.document: DeleteDocumentsHeaders

Represents the Headers record for the operation: deleteDocuments

Fields

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

microsoft.dynamics365.finance.document: DeleteDocumentTypesHeaders

Represents the Headers record for the operation: deleteDocumentTypes

Fields

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

microsoft.dynamics365.finance.document: DeleteEDParametersHeaders

Represents the Headers record for the operation: deleteEDParameters

Fields

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

microsoft.dynamics365.finance.document: DeleteGuidesHeaders

Represents the Headers record for the operation: deleteGuides

Fields

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

microsoft.dynamics365.finance.document: DeleteMediaHeaders

Represents the Headers record for the operation: deleteMedia

Fields

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

microsoft.dynamics365.finance.document: DeleteMediaTypesHeaders

Represents the Headers record for the operation: deleteMediaTypes

Fields

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

microsoft.dynamics365.finance.document: DeleteMessageItemsHeaders

Represents the Headers record for the operation: deleteMessageItems

Fields

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

microsoft.dynamics365.finance.document: DeleteMessagesLogsHeaders

Represents the Headers record for the operation: deleteMessagesLogs

Fields

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

microsoft.dynamics365.finance.document: DeleteMessageStatusHeaders

Represents the Headers record for the operation: deleteMessageStatus

Fields

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

microsoft.dynamics365.finance.document: DeletePrintLayoutsHeaders

Represents the Headers record for the operation: deletePrintLayouts

Fields

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

microsoft.dynamics365.finance.document: DemoDataPost

Fields

startDate? string -

dataAreaId? string -

lineNum? decimal -

documentTarget? DemoDataPostDocumentTarget -

dataProjectId? string -

demoDataJobStatus? DemoDataPostRunStatus -

fromDocument? string -

toDocument? string -

demoDataJob? string -

document? DemoDataPostDocument -

endDate? string -

processOnImport? NoYes -

microsoft.dynamics365.finance.document: DemoDataPostsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *DemoDataPostsCollectionAllOf2

value DemoDataPost[]
anydata...

microsoft.dynamics365.finance.document: DemoDataPostsCollectionAllOf2

Fields

value? DemoDataPost[] -

microsoft.dynamics365.finance.document: Document

Fields

unloadingState? string -

economicActivity? EconomicActivityType -

loadingDunsNumber? string -

loadingAddress? string -

unloadingStreetNumber? string -

loadingLongitude? decimal -

loadingDescription? string -

unloadingZipCode? string -

dataAreaId? string -

loadingTimeZone? Timezone -

unloadingCity? string -

loadingDateAndTime? string -

unloadingBuildingCompliment? string -

carrierType? CarrierTypeW -

riskLevelOfTheLoad? string -

loadingPostBox? string -

carrier? string -

loadingValidFrom? string -

loadingState? string -

trailerRegistrationNumber? string -

unloadingCountryRegionId? string -

loadingZipCode? string -

loadingCity? string -

unloadingLatitude? decimal -

loadingDistrictName? string -

unloadingLongitude? decimal -

loadingLocationId? string -

loadingCountryRegionISOCode? string -

vehicleModel? string -

loadingCountryRegionId? string -

loadingValidTo? string -

package? string -

loadingBuildingCompliment? string -

unloadingAddress? string -

unloadingStreet? string -

issuedByPersonnelNumber? string -

printTransportationDetails? NoYes -

unloadingDistrictName? string -

loadingIsPrivate? NoYes -

driverName? string -

loadingStreet? string -

unloadingLocationId? string -

unloadingDateAndTime? string -

unloadingTimeZone? Timezone -

registrationNumber? string -

documentDateTime? string -

unloadingValidFrom? string -

lineId? string -

unloadingCounty? string -

unloadingDescription? string -

loadingCounty? string -

unloadingValidTo? string -

loadingLatitude? decimal -

unloadingPostBox? string -

loadingStreetNumber? string -

unloadingIsPrivate? NoYes -

driverPersonnelNumber? string -

unloadingDunsNumber? string -

unloadingCountryRegionISOCode? string -

microsoft.dynamics365.finance.document: DocumentsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *DocumentsCollectionAllOf2

value Document[]
anydata...

microsoft.dynamics365.finance.document: DocumentsCollectionAllOf2

Fields

value? Document[] -

microsoft.dynamics365.finance.document: DocumentType

Fields

site? string -

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

actionClassName? string -

folderPath? string -

host? string -

filePlace? DocuFilePlace -

name? string -

dataAreaId? string -

typeGroup? DocuTypeGroup -

iD? string -

removeOption? DocuRemoveOption -

fileRemovalConfirmation? NoYes -

docuStructureType? DocuStructureType -

microsoft.dynamics365.finance.document: DocumentTypesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *DocumentTypesCollectionAllOf2

value DocumentType[]
anydata...

microsoft.dynamics365.finance.document: DocumentTypesCollectionAllOf2

Fields

value? DocumentType[] -

microsoft.dynamics365.finance.document: EDParameter

Fields

descriptionCust? NoYes -

approveStatus? NoYes -

currencyControlRequirementInSettling? NoYes -

custGroupingByProfitLoss? NoYes -

postingProfControlRequirementInSettling? NoYes -

vendGroupingByTax? NoYes -

custExchangeDifferenceTransDescription? NoYes -

custGetFullSettledInvoice? NoYes -

vendGetFullSettledInvoice? NoYes -

vendGroupingByProfitLoss? NoYes -

custGroupingByTax? NoYes -

custSingleInvoice? NoYes -

dataAreaId? string -

vendExchangeDifferenceTransDescription? NoYes -

vendSingleInvoice? NoYes -

custFillInvoiceNum? NoYes -

descriptionVend? NoYes -

vendGroupingByDimension? NoYes -

custGroupingByDimension? NoYes -

key? Signed32 -

vendFillInvoiceNum? NoYes -

microsoft.dynamics365.finance.document: EDParametersCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *EDParametersCollectionAllOf2

value EDParameter[]
anydata...

microsoft.dynamics365.finance.document: EDParametersCollectionAllOf2

Fields

value? EDParameter[] -

microsoft.dynamics365.finance.document: GetAgentFeedsQueries

Represents the Queries record for the operation: getAgentFeeds

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.document: GetAgentsQueries

Represents the Queries record for the operation: getAgents

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.document: GetDemoDataPostsQueries

Represents the Queries record for the operation: getDemoDataPosts

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.document: GetDocumentsQueries

Represents the Queries record for the operation: getDocuments

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.document: GetDocumentTypesQueries

Represents the Queries record for the operation: getDocumentTypes

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.document: GetEDParametersQueries

Represents the Queries record for the operation: getEDParameters

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.document: GetGuidesQueries

Represents the Queries record for the operation: getGuides

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.document: GetMediaQueries

Represents the Queries record for the operation: getMedia

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.document: GetMediaTypesQueries

Represents the Queries record for the operation: getMediaTypes

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.document: GetMessageItemsQueries

Represents the Queries record for the operation: getMessageItems

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.document: GetMessagesLogsQueries

Represents the Queries record for the operation: getMessagesLogs

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.document: GetMessageStatusQueries

Represents the Queries record for the operation: getMessageStatus

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.document: GetPrintLayoutsQueries

Represents the Queries record for the operation: getPrintLayouts

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.document: Guide

Fields

integrationKey? string -

schemaVersion? Signed32 -

lastModifiedOn? string -

createdOn? string -

guideID? string -

name? string -

microsoft.dynamics365.finance.document: GuidesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *GuidesCollectionAllOf2

value Guide[]
anydata...

microsoft.dynamics365.finance.document: GuidesCollectionAllOf2

Fields

value? Guide[] -

microsoft.dynamics365.finance.document: ListAgentFeedsQueries

Represents the Queries record for the operation: listAgentFeeds

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.document: ListAgentsQueries

Represents the Queries record for the operation: listAgents

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.document: ListDemoDataPostsQueries

Represents the Queries record for the operation: listDemoDataPosts

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.document: ListDocumentsQueries

Represents the Queries record for the operation: listDocuments

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.document: ListDocumentTypesQueries

Represents the Queries record for the operation: listDocumentTypes

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.document: ListEDParametersQueries

Represents the Queries record for the operation: listEDParameters

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.document: ListGuidesQueries

Represents the Queries record for the operation: listGuides

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.document: ListMediaQueries

Represents the Queries record for the operation: listMedia

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.document: ListMediaTypesQueries

Represents the Queries record for the operation: listMediaTypes

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.document: ListMessageItemsQueries

Represents the Queries record for the operation: listMessageItems

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.document: ListMessagesLogsQueries

Represents the Queries record for the operation: listMessagesLogs

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.document: ListMessageStatusQueries

Represents the Queries record for the operation: listMessageStatus

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.document: ListPrintLayoutsQueries

Represents the Queries record for the operation: listPrintLayouts

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.document: Media

Fields

building? string -

internetAddress? string -

description? string -

email? string -

telephone? string -

vendAccount? string -

groupOfHouses? string -

mobilePhone? string -

addressCounty? string -

dataAreaId? string -

language? string -

addressCity? string -

addressDescription? string -

addressValidFrom? string -

mediaType? string -

media? string -

apartment? string -

addressLocationId? string -

addressCountryRegionId? string -

extension? string -

addressCountryRegionISOCode? string -

settlement? string -

telexNumber? string -

addressStreet? string -

addressValidTo? string -

addressZipCode? string -

fax? string -

addressState? string -

microsoft.dynamics365.finance.document: MediaCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *MediaCollectionAllOf2

value Media[]
anydata...

microsoft.dynamics365.finance.document: MediaCollectionAllOf2

Fields

value? Media[] -

microsoft.dynamics365.finance.document: MediaType

Fields

dataAreaId? string -

mediaTypeId? string -

description? string -

microsoft.dynamics365.finance.document: MediaTypesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *MediaTypesCollectionAllOf2

value MediaType[]
anydata...

microsoft.dynamics365.finance.document: MediaTypesCollectionAllOf2

Fields

value? MediaType[] -

microsoft.dynamics365.finance.document: MessageItems

Fields

transDateTime? string -

dataAreaId? string -

itemStatus? string -

itemDate? string -

itemType? string -

processingId? string -

itemId? string -

messageId? string -

microsoft.dynamics365.finance.document: MessageItemsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *MessageItemsCollectionAllOf2

value MessageItems[]
anydata...

microsoft.dynamics365.finance.document: MessageItemsCollectionAllOf2

Fields

value? MessageItems[] -

microsoft.dynamics365.finance.document: MessagesLog

Fields

messageStatusIdFrom? string -

dataAreaId? string -

actionId? string -

messageStatusIdTo? string -

processingDescription? string -

processingCode? string -

messageId? string -

microsoft.dynamics365.finance.document: MessagesLogsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *MessagesLogsCollectionAllOf2

value MessagesLog[]
anydata...

microsoft.dynamics365.finance.document: MessagesLogsCollectionAllOf2

Fields

value? MessagesLog[] -

microsoft.dynamics365.finance.document: MessageStatus

Fields

dataAreaId? string -

messageStatus? string -

description? string -

messageItemStatus? string -

allowDelete? NoYes -

responseType? EMResponseType -

microsoft.dynamics365.finance.document: MessageStatusCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *MessageStatusCollectionAllOf2

value MessageStatus[]
anydata...

microsoft.dynamics365.finance.document: MessageStatusCollectionAllOf2

Fields

value? MessageStatus[] -

microsoft.dynamics365.finance.document: 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.document: ODataCollection

Fields

odataNextLink? string -

odataCount? int -

odataContext? string -

microsoft.dynamics365.finance.document: Parameters

Fields

cashFlowDimension? string -

cashflowCodeFormat? string -

fixedAssetGroupCodeFormat? string -

eRModelName? string -

balanceSheet? string -

cashflowAdditional? string -

orgNumber? string -

changesOfOwnersEquity? string -

industry? string -

dataAreaId? string -

depreciationLedgerDimensionDisplayValue? string -

incomeSheet? string -

orgType? GBTOrgTypeCN -

cashflowMajorSheet? string -

disposalLedgerDimensionDisplayValue? string -

acquisitionLedgerDimensionDisplayValue? string -

'key Signed32 -

microsoft.dynamics365.finance.document: PrintLayout

Fields

groupDescription? string -

dataAreaId? string -

printLayoutGroup? string -

printLayoutCode? LedgerPreprintVoucherCN -

codeDescription? string -

microsoft.dynamics365.finance.document: PrintLayoutsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *PrintLayoutsCollectionAllOf2

value PrintLayout[]
anydata...

microsoft.dynamics365.finance.document: PrintLayoutsCollectionAllOf2

Fields

value? PrintLayout[] -

microsoft.dynamics365.finance.document: UpdateAgentFeedsHeaders

Represents the Headers record for the operation: updateAgentFeeds

Fields

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

microsoft.dynamics365.finance.document: UpdateAgentsHeaders

Represents the Headers record for the operation: updateAgents

Fields

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

microsoft.dynamics365.finance.document: UpdateDemoDataPostsHeaders

Represents the Headers record for the operation: updateDemoDataPosts

Fields

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

microsoft.dynamics365.finance.document: UpdateDocumentsHeaders

Represents the Headers record for the operation: updateDocuments

Fields

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

microsoft.dynamics365.finance.document: UpdateDocumentTypesHeaders

Represents the Headers record for the operation: updateDocumentTypes

Fields

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

microsoft.dynamics365.finance.document: UpdateEDParametersHeaders

Represents the Headers record for the operation: updateEDParameters

Fields

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

microsoft.dynamics365.finance.document: UpdateGuidesHeaders

Represents the Headers record for the operation: updateGuides

Fields

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

microsoft.dynamics365.finance.document: UpdateMediaHeaders

Represents the Headers record for the operation: updateMedia

Fields

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

microsoft.dynamics365.finance.document: UpdateMediaTypesHeaders

Represents the Headers record for the operation: updateMediaTypes

Fields

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

microsoft.dynamics365.finance.document: UpdateMessageItemsHeaders

Represents the Headers record for the operation: updateMessageItems

Fields

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

microsoft.dynamics365.finance.document: UpdateMessagesLogsHeaders

Represents the Headers record for the operation: updateMessagesLogs

Fields

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

microsoft.dynamics365.finance.document: UpdateMessageStatusHeaders

Represents the Headers record for the operation: updateMessageStatus

Fields

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

microsoft.dynamics365.finance.document: UpdatePrintLayoutsHeaders

Represents the Headers record for the operation: updatePrintLayouts

Fields

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

Union types

microsoft.dynamics365.finance.document: EconomicActivityType

"None"|"DeliveryGoods"|"OtherTaxPayer"|"Transfer"

EconomicActivityType

microsoft.dynamics365.finance.document: CarrierTypeW

"InvoiceAccount"|"Customer"|"Vendor"

CarrierTypeW

microsoft.dynamics365.finance.document: Timezone

Timezone

microsoft.dynamics365.finance.document: DocuRemoveOption

"DocumentOnly"|"DocumentAndFile"

DocuRemoveOption

microsoft.dynamics365.finance.document: EMResponseType

EMResponseType

microsoft.dynamics365.finance.document: DocuTypeGroup

DocuTypeGroup

microsoft.dynamics365.finance.document: GBTOrgTypeCN

"Enterprise"|"NonProfitUndertaking"

GBTOrgTypeCN

microsoft.dynamics365.finance.document: DocuStructureType

DocuStructureType

microsoft.dynamics365.finance.document: NoYes

"No"|"Yes"

NoYes

microsoft.dynamics365.finance.document: DocuFilePlace

"Archive"|"Database"|"SharePoint"

DocuFilePlace

microsoft.dynamics365.finance.document: LedgerPreprintVoucherCN

"TR101"|"TW101"

LedgerPreprintVoucherCN

microsoft.dynamics365.finance.document: DemoDataPostDocumentTarget

DemoDataPostDocumentTarget

microsoft.dynamics365.finance.document: DemoDataPostDocument

DemoDataPostDocument

microsoft.dynamics365.finance.document: AgentFeedItemStatus

"NotStarted"|"InProgress"|"Completed"|"Canceled"

AgentFeedItemStatus

microsoft.dynamics365.finance.document: DemoDataPostRunStatus

DemoDataPostRunStatus

Import

import ballerinax/microsoft.dynamics365.finance.document;

Other versions

0.8.0

Metadata

Released date: 2 days 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 Document

Area/System

Vendor/Microsoft

Dynamics365

Finance

ERP

Type/Connector

Document

Media

Message

Agent

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.document 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.document: Client

Constructor

listAgentFeeds

Parameters

Return Type

createAgentFeeds

Parameters

Return Type

getAgentFeeds

Parameters

Return Type

deleteAgentFeeds

Parameters

Return Type

updateAgentFeeds

Parameters

Return Type

listAgents

Parameters

Return Type

createAgents

Parameters

Return Type

getAgents

Parameters

Return Type

deleteAgents

Parameters

Return Type

updateAgents

Parameters

Return Type

listDemoDataPosts

Parameters

Return Type

createDemoDataPosts

Parameters

Return Type

getDemoDataPosts

Parameters

Return Type

deleteDemoDataPosts

Parameters

Return Type

updateDemoDataPosts

Parameters

Return Type

listDocumentTypes

Parameters

Return Type

createDocumentTypes

Parameters

Return Type

getDocumentTypes

Parameters

Return Type

deleteDocumentTypes

Parameters

Return Type

updateDocumentTypes

Parameters

Return Type