Module microsoft.dynamics365.finance.core

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

Key Features

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

Step 1: Import the module


import ballerinax/microsoft.dynamics365.finance.core;

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"

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


core:AddressBooksCollection results = check cl->listAddressBooks();

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

listAddressBooks

Isolated FunctionRemote Function

function listAddressBooks(map<string|string[]> headers, *ListAddressBooksQueries queries) returns AddressBooksCollection|error

List AddressBooks

Parameters

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

queries *ListAddressBooksQueries - Queries to be sent with the request

Return Type

AddressBooksCollection|error - Collection of AddressBooks

createAddressBooks

Isolated FunctionRemote Function

function createAddressBooks(AddressBooks payload, map<string|string[]> headers) returns AddressBooks|error

Create AddressBooks

Parameters

payload AddressBooks - The request body

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

Return Type

AddressBooks|error - AddressBooks created

getAddressBooks

Isolated FunctionRemote Function

function getAddressBooks(string name, map<string|string[]> headers, *GetAddressBooksQueries queries) returns AddressBooks|error

Get AddressBooks by key

Parameters

name string - The name key field

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

queries *GetAddressBooksQueries - Queries to be sent with the request

Return Type

AddressBooks|error - AddressBooks

deleteAddressBooks

Isolated FunctionRemote Function

function deleteAddressBooks(string name, DeleteAddressBooksHeaders headers) returns error?

Delete AddressBooks

Parameters

name string - The name key field

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

Return Type

error? - AddressBooks deleted

updateAddressBooks

Isolated FunctionRemote Function

function updateAddressBooks(string name, AddressBooks payload, UpdateAddressBooksHeaders headers) returns AddressBooks|error

Update AddressBooks

Parameters

name string - The name key field

payload AddressBooks - The request body

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

Return Type

AddressBooks|error - AddressBooks updated

listAddressCities

Isolated FunctionRemote Function

function listAddressCities(map<string|string[]> headers, *ListAddressCitiesQueries queries) returns AddressCitiesCollection|error

List AddressCities

Parameters

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

queries *ListAddressCitiesQueries - Queries to be sent with the request

Return Type

AddressCitiesCollection|error - Collection of AddressCity

createAddressCities

Isolated FunctionRemote Function

function createAddressCities(AddressCity payload, map<string|string[]> headers) returns AddressCity|error

Create AddressCity

Parameters

payload AddressCity - The request body

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

Return Type

AddressCity|error - AddressCity created

getAddressCities

Isolated FunctionRemote Function

function getAddressCities(string cityKey, map<string|string[]> headers, *GetAddressCitiesQueries queries) returns AddressCity|error

Get AddressCity by key

Parameters

cityKey string - The city key key field

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

queries *GetAddressCitiesQueries - Queries to be sent with the request

Return Type

AddressCity|error - AddressCity

deleteAddressCities

Isolated FunctionRemote Function

function deleteAddressCities(string cityKey, DeleteAddressCitiesHeaders headers) returns error?

Delete AddressCity

Parameters

cityKey string - The city key key field

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

Return Type

error? - AddressCity deleted

updateAddressCities

Isolated FunctionRemote Function

function updateAddressCities(string cityKey, AddressCity payload, UpdateAddressCitiesHeaders headers) returns AddressCity|error

Update AddressCity

Parameters

cityKey string - The city key key field

payload AddressCity - The request body

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

Return Type

AddressCity|error - AddressCity updated

listAddressFormats

Isolated FunctionRemote Function

function listAddressFormats(map<string|string[]> headers, *ListAddressFormatsQueries queries) returns AddressFormatsCollection|error

List AddressFormats

Parameters

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

queries *ListAddressFormatsQueries - Queries to be sent with the request

Return Type

AddressFormatsCollection|error - Collection of AddressFormat

createAddressFormats

Isolated FunctionRemote Function

function createAddressFormats(AddressFormat payload, map<string|string[]> headers) returns AddressFormat|error

Create AddressFormat

Parameters

payload AddressFormat - The request body

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

Return Type

AddressFormat|error - AddressFormat created

getAddressFormats

Isolated FunctionRemote Function

function getAddressFormats(string addressFormat, map<string|string[]> headers, *GetAddressFormatsQueries queries) returns AddressFormat|error

Get AddressFormat by key

Parameters

addressFormat string - The address format key field

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

queries *GetAddressFormatsQueries - Queries to be sent with the request

Return Type

AddressFormat|error - AddressFormat

deleteAddressFormats

Isolated FunctionRemote Function

function deleteAddressFormats(string addressFormat, DeleteAddressFormatsHeaders headers) returns error?

Delete AddressFormat

Parameters

addressFormat string - The address format key field

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

Return Type

error? - AddressFormat deleted

updateAddressFormats

Isolated FunctionRemote Function

function updateAddressFormats(string addressFormat, AddressFormat payload, UpdateAddressFormatsHeaders headers) returns AddressFormat|error

Update AddressFormat

Parameters

addressFormat string - The address format key field

payload AddressFormat - The request body

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

Return Type

AddressFormat|error - AddressFormat updated

listAddressObjects

Isolated FunctionRemote Function

function listAddressObjects(map<string|string[]> headers, *ListAddressObjectsQueries queries) returns AddressObjectsCollection|error

List AddressObjects

Parameters

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

queries *ListAddressObjectsQueries - Queries to be sent with the request

Return Type

AddressObjectsCollection|error - Collection of AddressObject

createAddressObjects

Isolated FunctionRemote Function

function createAddressObjects(AddressObject payload, map<string|string[]> headers) returns AddressObject|error

Create AddressObject

Parameters

payload AddressObject - The request body

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

Return Type

AddressObject|error - AddressObject created

getAddressObjects

Isolated FunctionRemote Function

function getAddressObjects(string dataAreaId, string aOId, map<string|string[]> headers, *GetAddressObjectsQueries queries) returns AddressObject|error

Get AddressObject by key

Parameters

dataAreaId string - The company data area identifier

aOId string - The a o id key field

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

queries *GetAddressObjectsQueries - Queries to be sent with the request

Return Type

AddressObject|error - AddressObject

deleteAddressObjects

Isolated FunctionRemote Function

function deleteAddressObjects(string dataAreaId, string aOId, DeleteAddressObjectsHeaders headers) returns error?

Delete AddressObject

Parameters

dataAreaId string - The company data area identifier

aOId string - The a o id key field

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

Return Type

error? - AddressObject deleted

updateAddressObjects

Isolated FunctionRemote Function

function updateAddressObjects(string dataAreaId, string aOId, AddressObject payload, UpdateAddressObjectsHeaders headers) returns AddressObject|error

Update AddressObject

Parameters

dataAreaId string - The company data area identifier

aOId string - The a o id key field

payload AddressObject - The request body

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

Return Type

AddressObject|error - AddressObject updated

listAddressStates

Isolated FunctionRemote Function

function listAddressStates(map<string|string[]> headers, *ListAddressStatesQueries queries) returns AddressStatesCollection|error

List AddressStates

Parameters

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

queries *ListAddressStatesQueries - Queries to be sent with the request

Return Type

AddressStatesCollection|error - Collection of AddressState

createAddressStates

Isolated FunctionRemote Function

function createAddressStates(AddressState payload, map<string|string[]> headers) returns AddressState|error

Create AddressState

Parameters

payload AddressState - The request body

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

Return Type

AddressState|error - AddressState created

getAddressStates

Isolated FunctionRemote Function

function getAddressStates(string countryRegionId, string state, map<string|string[]> headers, *GetAddressStatesQueries queries) returns AddressState|error

Get AddressState by key

Parameters

countryRegionId string - The country region id key field

state string - The state key field

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

queries *GetAddressStatesQueries - Queries to be sent with the request

Return Type

AddressState|error - AddressState

deleteAddressStates

Isolated FunctionRemote Function

function deleteAddressStates(string countryRegionId, string state, DeleteAddressStatesHeaders headers) returns error?

Delete AddressState

Parameters

countryRegionId string - The country region id key field

state string - The state key field

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

Return Type

error? - AddressState deleted

updateAddressStates

Isolated FunctionRemote Function

function updateAddressStates(string countryRegionId, string state, AddressState payload, UpdateAddressStatesHeaders headers) returns AddressState|error

Update AddressState

Parameters

countryRegionId string - The country region id key field

state string - The state key field

payload AddressState - The request body

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

Return Type

AddressState|error - AddressState updated

listBranches

Isolated FunctionRemote Function

function listBranches(map<string|string[]> headers, *ListBranchesQueries queries) returns BranchesCollection|error

List Branches

Parameters

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

queries *ListBranchesQueries - Queries to be sent with the request

Return Type

BranchesCollection|error - Collection of Branch

createBranches

Isolated FunctionRemote Function

function createBranches(Branch payload, map<string|string[]> headers) returns Branch|error

Create Branch

Parameters

payload Branch - The request body

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

Return Type

Branch|error - Branch created

getBranches

Isolated FunctionRemote Function

function getBranches(string dataAreaId, string code, map<string|string[]> headers, *GetBranchesQueries queries) returns Branch|error

Get Branch by key

Parameters

dataAreaId string - The company data area identifier

code string - The code key field

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

queries *GetBranchesQueries - Queries to be sent with the request

Return Type

Branch|error - Branch

deleteBranches

Isolated FunctionRemote Function

function deleteBranches(string dataAreaId, string code, DeleteBranchesHeaders headers) returns error?

Delete Branch

Parameters

dataAreaId string - The company data area identifier

code string - The code key field

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

Return Type

error? - Branch deleted

updateBranches

Isolated FunctionRemote Function

function updateBranches(string dataAreaId, string code, Branch payload, UpdateBranchesHeaders headers) returns Branch|error

Update Branch

Parameters

dataAreaId string - The company data area identifier

code string - The code key field

payload Branch - The request body

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

Return Type

Branch|error - Branch updated

listBusinessUnits

Isolated FunctionRemote Function

function listBusinessUnits(map<string|string[]> headers, *ListBusinessUnitsQueries queries) returns BusinessUnitsCollection|error

List BusinessUnits

Parameters

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

queries *ListBusinessUnitsQueries - Queries to be sent with the request

Return Type

BusinessUnitsCollection|error - Collection of BusinessUnit

createBusinessUnits

Isolated FunctionRemote Function

function createBusinessUnits(BusinessUnit payload, map<string|string[]> headers) returns BusinessUnit|error

Create BusinessUnit

Parameters

payload BusinessUnit - The request body

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

Return Type

BusinessUnit|error - BusinessUnit created

getBusinessUnits

Isolated FunctionRemote Function

function getBusinessUnits(string operatingUnitNumber, map<string|string[]> headers, *GetBusinessUnitsQueries queries) returns BusinessUnit|error

Get BusinessUnit by key

Parameters

operatingUnitNumber string - The operating unit number key field

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

queries *GetBusinessUnitsQueries - Queries to be sent with the request

Return Type

BusinessUnit|error - BusinessUnit

deleteBusinessUnits

Isolated FunctionRemote Function

function deleteBusinessUnits(string operatingUnitNumber, DeleteBusinessUnitsHeaders headers) returns error?

Delete BusinessUnit

Parameters

operatingUnitNumber string - The operating unit number key field

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

Return Type

error? - BusinessUnit deleted

updateBusinessUnits

Isolated FunctionRemote Function

function updateBusinessUnits(string operatingUnitNumber, BusinessUnit payload, UpdateBusinessUnitsHeaders headers) returns BusinessUnit|error

Update BusinessUnit

Parameters

operatingUnitNumber string - The operating unit number key field

payload BusinessUnit - The request body

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

Return Type

BusinessUnit|error - BusinessUnit updated

listCDSParties

Isolated FunctionRemote Function

function listCDSParties(map<string|string[]> headers, *ListCDSPartiesQueries queries) returns CDSPartiesCollection|error

List CDSParties

Parameters

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

queries *ListCDSPartiesQueries - Queries to be sent with the request

Return Type

CDSPartiesCollection|error - Collection of CDSParty

createCDSParties

Isolated FunctionRemote Function

function createCDSParties(CDSParty payload, map<string|string[]> headers) returns CDSParty|error

Create CDSParty

Parameters

payload CDSParty - The request body

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

Return Type

CDSParty|error - CDSParty created

getCDSParties

Isolated FunctionRemote Function

function getCDSParties(string partyNumber, map<string|string[]> headers, *GetCDSPartiesQueries queries) returns CDSParty|error

Get CDSParty by key

Parameters

partyNumber string - The party number key field

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

queries *GetCDSPartiesQueries - Queries to be sent with the request

Return Type

CDSParty|error - CDSParty

deleteCDSParties

Isolated FunctionRemote Function

function deleteCDSParties(string partyNumber, DeleteCDSPartiesHeaders headers) returns error?

Delete CDSParty

Parameters

partyNumber string - The party number key field

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

Return Type

error? - CDSParty deleted

updateCDSParties

Isolated FunctionRemote Function

function updateCDSParties(string partyNumber, CDSParty payload, UpdateCDSPartiesHeaders headers) returns CDSParty|error

Update CDSParty

Parameters

partyNumber string - The party number key field

payload CDSParty - The request body

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

Return Type

CDSParty|error - CDSParty updated

listCompanies

Isolated FunctionRemote Function

function listCompanies(map<string|string[]> headers, *ListCompaniesQueries queries) returns CompaniesCollection|error

List Companies

Parameters

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

queries *ListCompaniesQueries - Queries to be sent with the request

Return Type

CompaniesCollection|error - Collection of Company

createCompanies

Isolated FunctionRemote Function

function createCompanies(Company payload, map<string|string[]> headers) returns Company|error

Create Company

Parameters

payload Company - The request body

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

Return Type

Company|error - Company created

getCompanies

Isolated FunctionRemote Function

function getCompanies(string dataArea, map<string|string[]> headers, *GetCompaniesQueries queries) returns Company|error

Get Company by key

Parameters

dataArea string - The data area key field

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

queries *GetCompaniesQueries - Queries to be sent with the request

Return Type

Company|error - Company

deleteCompanies

Isolated FunctionRemote Function

function deleteCompanies(string dataArea, DeleteCompaniesHeaders headers) returns error?

Delete Company

Parameters

dataArea string - The data area key field

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

Return Type

error? - Company deleted

updateCompanies

Isolated FunctionRemote Function

function updateCompanies(string dataArea, Company payload, UpdateCompaniesHeaders headers) returns Company|error

Update Company

Parameters

dataArea string - The data area key field

payload Company - The request body

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

Return Type

Company|error - Company updated

listDepartments

Isolated FunctionRemote Function

function listDepartments(map<string|string[]> headers, *ListDepartmentsQueries queries) returns DepartmentsCollection|error

List Departments

Parameters

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

queries *ListDepartmentsQueries - Queries to be sent with the request

Return Type

DepartmentsCollection|error - Collection of Department

createDepartments

Isolated FunctionRemote Function

function createDepartments(Department payload, map<string|string[]> headers) returns Department|error

Create Department

Parameters

payload Department - The request body

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

Return Type

Department|error - Department created

getDepartments

Isolated FunctionRemote Function

function getDepartments(string partyNumber, map<string|string[]> headers, *GetDepartmentsQueries queries) returns Department|error

Get Department by key

Parameters

partyNumber string - The party number key field

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

queries *GetDepartmentsQueries - Queries to be sent with the request

Return Type

Department|error - Department

deleteDepartments

Isolated FunctionRemote Function

function deleteDepartments(string partyNumber, DeleteDepartmentsHeaders headers) returns error?

Delete Department

Parameters

partyNumber string - The party number key field

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

Return Type

error? - Department deleted

updateDepartments

Isolated FunctionRemote Function

function updateDepartments(string partyNumber, Department payload, UpdateDepartmentsHeaders headers) returns Department|error

Update Department

Parameters

partyNumber string - The party number key field

payload Department - The request body

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

Return Type

Department|error - Department updated

listDepartmentsV2

Isolated FunctionRemote Function

function listDepartmentsV2(map<string|string[]> headers, *ListDepartmentsV2Queries queries) returns DepartmentsV2Collection|error

List DepartmentsV2

Parameters

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

queries *ListDepartmentsV2Queries - Queries to be sent with the request

Return Type

DepartmentsV2Collection|error - Collection of DepartmentV2

createDepartmentsV2

Isolated FunctionRemote Function

function createDepartmentsV2(DepartmentV2 payload, map<string|string[]> headers) returns DepartmentV2|error

Create DepartmentV2

Parameters

payload DepartmentV2 - The request body

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

Return Type

DepartmentV2|error - DepartmentV2 created

getDepartmentsV2

Isolated FunctionRemote Function

function getDepartmentsV2(string operatingUnitNumber, map<string|string[]> headers, *GetDepartmentsV2Queries queries) returns DepartmentV2|error

Get DepartmentV2 by key

Parameters

operatingUnitNumber string - The operating unit number key field

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

queries *GetDepartmentsV2Queries - Queries to be sent with the request

Return Type

DepartmentV2|error - DepartmentV2

deleteDepartmentsV2

Isolated FunctionRemote Function

function deleteDepartmentsV2(string operatingUnitNumber, DeleteDepartmentsV2Headers headers) returns error?

Delete DepartmentV2

Parameters

operatingUnitNumber string - The operating unit number key field

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

Return Type

error? - DepartmentV2 deleted

updateDepartmentsV2

Isolated FunctionRemote Function

function updateDepartmentsV2(string operatingUnitNumber, DepartmentV2 payload, UpdateDepartmentsV2Headers headers) returns DepartmentV2|error

Update DepartmentV2

Parameters

operatingUnitNumber string - The operating unit number key field

payload DepartmentV2 - The request body

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

Return Type

DepartmentV2|error - DepartmentV2 updated

Records

microsoft.dynamics365.finance.core: AddressBooks

Fields

description? string -

system? NoYes -

name? string -

microsoft.dynamics365.finance.core: AddressBooksCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AddressBooksCollectionAllOf2

value AddressBooks[]
anydata...

microsoft.dynamics365.finance.core: AddressBooksCollectionAllOf2

Fields

value? AddressBooks[] -

microsoft.dynamics365.finance.core: AddressCitiesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AddressCitiesCollectionAllOf2

value AddressCity[]
anydata...

microsoft.dynamics365.finance.core: AddressCitiesCollectionAllOf2

Fields

value? AddressCity[] -

microsoft.dynamics365.finance.core: AddressCity

Fields

description? string -

countryRegionId? string -

stateId? string -

countyId? string -

italyCityCode? string -

cityKey? string -

italyMunicipalityCode? string -

cityInKana? string -

brazilCityCode? string -

name? string -

microsoft.dynamics365.finance.core: AddressFormat

Fields

addressFormat? string -

description? string -

microsoft.dynamics365.finance.core: AddressFormatsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AddressFormatsCollectionAllOf2

value AddressFormat[]
anydata...

microsoft.dynamics365.finance.core: AddressFormatsCollectionAllOf2

Fields

value? AddressFormat[] -

microsoft.dynamics365.finance.core: AddressObject

Fields

cityCode? string -

regionCode? string -

parentGuid? string -

placeCode? string -

postalCode? string -

shortName? string -

terrIFNSFL? string -

dataAreaId? string -

aOLevel? string -

oKATO? string -

planCode? string -

offName? string -

operStatus? string -

extrCode? string -

liveStatus? string -

nextId? string -

divType? string -

aOGuid? string -

aOId? string -

prevId? string -

iFNSFL? string -

streetCode? string -

areaCode? string -

ctArCode? string -

actStatus? string -

microsoft.dynamics365.finance.core: AddressObjectsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AddressObjectsCollectionAllOf2

value AddressObject[]
anydata...

microsoft.dynamics365.finance.core: AddressObjectsCollectionAllOf2

Fields

value? AddressObject[] -

microsoft.dynamics365.finance.core: AddressState

Fields

brazilStateCode? string -

timeZone? Timezone -

defaultStateForCountryRegion? NoYes -

countryRegionId? string -

state? string -

intrastatCode? string -

name? string -

microsoft.dynamics365.finance.core: AddressStatesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *AddressStatesCollectionAllOf2

value AddressState[]
anydata...

microsoft.dynamics365.finance.core: AddressStatesCollectionAllOf2

Fields

value? AddressState[] -

microsoft.dynamics365.finance.core: Branch

Fields

dataAreaId? string -

address? string -

logisticsLocationLocationId? string -

headOffice? NoYes -

code? string -

name? string -

microsoft.dynamics365.finance.core: BranchesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *BranchesCollectionAllOf2

value Branch[]
anydata...

microsoft.dynamics365.finance.core: BranchesCollectionAllOf2

Fields

value? Branch[] -

microsoft.dynamics365.finance.core: BusinessUnit

Fields

primaryContactEmailPurpose? string -

primaryContactEmail? string -

primaryContactPhonePurpose? string -

name? string -

primaryContactPhoneDescription? string -

addressCity? string -

primaryContactTwitterDescription? string -

addressLongitude? decimal -

primaryContactTwitter? string -

addressValidFrom? string -

primaryContactPhoneExtension? string -

primaryContactEmailIsIM? NoYes -

operatingUnitType? OMOperatingUnitType -

primaryContactFax? string -

addressTimeZone? Timezone -

primaryContactLinkedIn? string -

dunsNumber? string -

addressLocationId? string -

addressCountryRegionId? string -

primaryContactTwitterPurpose? string -

addressCountryRegionISOCode? string -

fullPrimaryAddress? string -

primaryContactLinkedInPurpose? string -

phoneticName? string -

nameAlias? string -

addressValidTo? string -

primaryContactURLDescription? string -

primaryContactFacebookDescription? string -

addressZipCode? string -

operatingUnitNumber? string -

addressLocationRoles? string -

addressBooks? string -

primaryContactURL? string -

primaryContactFacebookPurpose? string -

primaryContactLinkedInIsPrivate? NoYes -

primaryContactURLPurpose? string -

addressCounty? string -

primaryContactEmailDescription? string -

primaryContactLinkedInDescription? string -

addressDescription? string -

primaryContactTwitterIsPrivate? NoYes -

primaryContactPhoneIsMobile? NoYes -

primaryContactPhone? string -

primaryContactTelexDescription? string -

primaryContactFaxExtension? string -

primaryContactTelexPurpose? string -

primaryContactFacebook? string -

electronicLocationId? string -

primaryContactFacebookIsPrivate? NoYes -

addressDistrictName? string -

partyNumber? string -

primaryContactFaxPurpose? string -

primaryContactFaxDescription? string -

primaryContactTelex? string -

addressStreet? string -

languageId? string -

addressState? string -

addressLatitude? decimal -

microsoft.dynamics365.finance.core: BusinessUnitsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *BusinessUnitsCollectionAllOf2

value BusinessUnit[]
anydata...

microsoft.dynamics365.finance.core: BusinessUnitsCollectionAllOf2

Fields

value? BusinessUnit[] -

microsoft.dynamics365.finance.core: CDSPartiesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *CDSPartiesCollectionAllOf2

value CDSParty[]
anydata...

microsoft.dynamics365.finance.core: CDSPartiesCollectionAllOf2

Fields

value? CDSParty[] -

microsoft.dynamics365.finance.core: CDSParty

Fields

organizationName? string -

personPhoneticLastName? string -

organizationNumber? string -

personBirthMonth? MonthsOfYear -

addressBooks? string -

personLastNamePrefix? string -

knownAs? string -

personMiddleName? string -

personPhoneticFirstName? string -

personAnniversaryMonth? MonthsOfYear -

personPersonalTitle? string -

personAnniversaryYear? Signed32 -

personPhoneticMiddleName? string -

personBirthDay? Signed32 -

partyType? string -

personPersonalSuffix? string -

personLastName? string -

organizationABCCode? ABC -

personAnniversaryDay? Signed32 -

personProfessionalSuffix? string -

personBirthYear? Signed32 -

personFirstName? string -

personMaritalStatus? DirPersonMaritalStatus -

partyNumber? string -

organizationPhoneticName? string -

organizationNumOfEmployees? Signed32 -

personProfessionalTitle? string -

personHobbies? string -

nameAlias? string -

personInitials? string -

personGender? Gender -

languageId? string -

personChildrenNames? string -

microsoft.dynamics365.finance.core: CompaniesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *CompaniesCollectionAllOf2

value Company[]
anydata...

microsoft.dynamics365.finance.core: CompaniesCollectionAllOf2

Fields

value? Company[] -

microsoft.dynamics365.finance.core: Company

Fields

partyNumber? string -

dataArea? string -

knownAs? string -

languageId? string -

name? string -

microsoft.dynamics365.finance.core: 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.core: DeleteAddressBooksHeaders

Represents the Headers record for the operation: deleteAddressBooks

Fields

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

microsoft.dynamics365.finance.core: DeleteAddressCitiesHeaders

Represents the Headers record for the operation: deleteAddressCities

Fields

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

microsoft.dynamics365.finance.core: DeleteAddressFormatsHeaders

Represents the Headers record for the operation: deleteAddressFormats

Fields

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

microsoft.dynamics365.finance.core: DeleteAddressObjectsHeaders

Represents the Headers record for the operation: deleteAddressObjects

Fields

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

microsoft.dynamics365.finance.core: DeleteAddressStatesHeaders

Represents the Headers record for the operation: deleteAddressStates

Fields

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

microsoft.dynamics365.finance.core: DeleteBranchesHeaders

Represents the Headers record for the operation: deleteBranches

Fields

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

microsoft.dynamics365.finance.core: DeleteBusinessUnitsHeaders

Represents the Headers record for the operation: deleteBusinessUnits

Fields

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

microsoft.dynamics365.finance.core: DeleteCDSPartiesHeaders

Represents the Headers record for the operation: deleteCDSParties

Fields

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

microsoft.dynamics365.finance.core: DeleteCompaniesHeaders

Represents the Headers record for the operation: deleteCompanies

Fields

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

microsoft.dynamics365.finance.core: DeleteDepartmentsHeaders

Represents the Headers record for the operation: deleteDepartments

Fields

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

microsoft.dynamics365.finance.core: DeleteDepartmentsV2Headers

Represents the Headers record for the operation: deleteDepartmentsV2

Fields

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

microsoft.dynamics365.finance.core: Department

Fields

primaryContactEmailPurpose? string -

searchName? string -

primaryContactEmail? string -

primaryContactPhonePurpose? string -

name? string -

primaryContactPhoneDescription? string -

primaryAddressDescription? string -

primaryContactTwitterDescription? string -

primaryContactTwitter? string -

primaryContactEmailIsIM? NoYes -

primaryContactPhoneExtension? string -

primaryAddressCity? string -

primaryContactFax? string -

primaryContactLinkedIn? string -

primaryContactTwitterPurpose? string -

primaryContactLinkedInPurpose? string -

primaryContactURLDescription? string -

primaryContactFacebookDescription? string -

primaryAddressStreet? string -

operatingUnitNumber? string -

addressLocationRoles? string -

primaryAddressCounty? string -

primaryContactURL? string -

primaryContactFacebookPurpose? string -

knownAs? string -

primaryContactLinkedInIsPrivate? NoYes -

primaryAddressState? string -

primaryContactURLPurpose? string -

primaryContactEmailDescription? string -

language? string -

operatingUnitTypes? OMOperatingUnitType -

primaryContactLinkedInDescription? string -

primaryContactTwitterIsPrivate? NoYes -

primaryAddressCountryRegionISOCode? string -

primaryContactPhoneIsMobile? NoYes -

partyType? string -

primaryContactPhone? string -

primaryContactTelexDescription? string -

primaryContactFaxExtension? string -

primaryContactTelexPurpose? string -

primaryContactFacebook? string -

primaryContactFacebookIsPrivate? NoYes -

organizationType? OMInternalOrganizationType -

partyNumber? string -

primaryContactFaxPurpose? string -

primaryContactFaxDescription? string -

primaryAddressCountryRegionId? string -

primaryContactTelex? string -

primaryAddressValidFrom? string -

primaryAddressValidTo? string -

primaryAddressZipCode? string -

memo? string -

microsoft.dynamics365.finance.core: DepartmentsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *DepartmentsCollectionAllOf2

value Department[]
anydata...

microsoft.dynamics365.finance.core: DepartmentsCollectionAllOf2

Fields

value? Department[] -

microsoft.dynamics365.finance.core: DepartmentsV2Collection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *DepartmentsV2CollectionAllOf2

value DepartmentV2[]
anydata...

microsoft.dynamics365.finance.core: DepartmentsV2CollectionAllOf2

Fields

value? DepartmentV2[] -

microsoft.dynamics365.finance.core: DepartmentV2

Fields

primaryContactEmailPurpose? string -

searchName? string -

primaryContactEmail? string -

primaryContactPhonePurpose? string -

name? string -

primaryContactPhoneDescription? string -

primaryAddressDescription? string -

primaryContactTwitterDescription? string -

primaryContactTwitter? string -

primaryContactEmailIsIM? NoYes -

primaryContactPhoneExtension? string -

primaryAddressCity? string -

primaryContactFax? string -

primaryContactLinkedIn? string -

primaryContactTwitterPurpose? string -

primaryContactLinkedInPurpose? string -

primaryContactURLDescription? string -

primaryContactFacebookDescription? string -

operatingUnitNumber? string -

primaryAddressStreet? string -

addressLocationRoles? string -

primaryAddressCounty? string -

primaryContactURL? string -

primaryContactFacebookPurpose? string -

knownAs? string -

primaryContactLinkedInIsPrivate? NoYes -

primaryAddressState? string -

primaryContactURLPurpose? string -

primaryContactEmailDescription? string -

language? string -

operatingUnitTypes? OMOperatingUnitType -

primaryContactLinkedInDescription? string -

primaryContactTwitterIsPrivate? NoYes -

primaryAddressCountryRegionISOCode? string -

primaryContactPhoneIsMobile? NoYes -

partyType? string -

primaryContactPhone? string -

primaryContactTelexDescription? string -

primaryContactFaxExtension? string -

primaryContactTelexPurpose? string -

primaryContactFacebook? string -

primaryContactFacebookIsPrivate? NoYes -

organizationType? OMInternalOrganizationType -

partyNumber? string -

primaryContactFaxPurpose? string -

primaryContactFaxDescription? string -

primaryAddressCountryRegionId? string -

primaryContactTelex? string -

primaryAddressValidFrom? string -

primaryAddressValidTo? string -

primaryAddressZipCode? string -

memo? string -

microsoft.dynamics365.finance.core: GetAddressBooksQueries

Represents the Queries record for the operation: getAddressBooks

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.core: GetAddressCitiesQueries

Represents the Queries record for the operation: getAddressCities

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.core: GetAddressFormatsQueries

Represents the Queries record for the operation: getAddressFormats

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.core: GetAddressObjectsQueries

Represents the Queries record for the operation: getAddressObjects

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.core: GetAddressStatesQueries

Represents the Queries record for the operation: getAddressStates

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.core: GetBranchesQueries

Represents the Queries record for the operation: getBranches

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.core: GetBusinessUnitsQueries

Represents the Queries record for the operation: getBusinessUnits

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.core: GetCDSPartiesQueries

Represents the Queries record for the operation: getCDSParties

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.core: GetCompaniesQueries

Represents the Queries record for the operation: getCompanies

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.core: GetDepartmentsQueries

Represents the Queries record for the operation: getDepartments

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.core: GetDepartmentsV2Queries

Represents the Queries record for the operation: getDepartmentsV2

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.core: LegalEntity

Fields

primaryContactEmailPurpose? string -

fiscalCode? string -

primaryContactEmail? string -

cUC? string -

nationalClassificationOfCompanyEconomicActivity? string -

addressCity? string -

addressLongitude? decimal -

primaryContactTwitter? string -

primaryContactEmailIsIM? NoYes -

printINNKPPInAddress? NoYes -

legalNature? LegalNatureIT -

accountsOfficeReferenceNumber? string -

primaryContactFax? string -

useForFinancialEliminationProcess? NoYes -

importVATNum? string -

primaryContactLinkedIn? string -

companyType? CompanyTypeMX -

startDateOfBusiness? string -

addressCountryRegionId? string -

primaryContactTwitterPurpose? string -

addressCountryRegionISOCode? string -

fullPrimaryAddress? string -

primaryContactLinkedInPurpose? string -

timeZone? Timezone -

nameAlias? string -

primaryAddressLocationId? string -

primaryContactURLDescription? string -

primaryContactFacebookDescription? string -

addressZipCode? string -

vATOnCustomerBehalf? NoYes -

addressLocationRoles? string -

softwareIdentificationCode? string -

stateInscription? string -

externalLegalRepresentativeName? string -

primaryContactURLPurpose? string -

printCorrectiveInvoice? NoYes -

rfcLegalRepresentative? string -

dNBRoutingNumber? string -

legalEntityId? string -

addressDescription? string -

profitMarginScheme? NoYes -

registrationNumber? string -

traderNumber? string -

primaryContactPhoneIsMobile? NoYes -

certifiedTaxAccountantName? string -

accountingPersonnel? string -

primaryContactFacebook? string -

primaryContactFacebookIsPrivate? NoYes -

useForFinancialConsolidationProcess? NoYes -

primaryContactFaxPurpose? string -

addressStreet? string -

nationalRegistryNumber? string -

vATRefund? NoYes -

curpNumber? string -

primaryContactPhonePurpose? string -

rfc? string -

name? string -

nAICS? string -

companyName? string -

primaryContactPhoneDescription? string -

primaryContactTwitterDescription? string -

addressValidFrom? string -

primaryContactPhoneExtension? string -

initialCapitalInvestment? decimal -

legalForm? string -

printEnterpriseRegister? NoYes -

addressTimeZone? Timezone -

reportFolder? string -

phoneticName? string -

legalRepresentativeName? string -

personInCharge? string -

addressValidTo? string -

businessItem? string -

vATNum? string -

companyRepresentative? string -

addressBooks? string -

primaryContactURL? string -

primaryContactFacebookPurpose? string -

primaryContactLinkedInIsPrivate? NoYes -

addressCounty? string -

printCorrectiveInvoiceStartingDate? string -

primaryContactEmailDescription? string -

primaryContactLinkedInDescription? string -

primaryContactTwitterIsPrivate? NoYes -

curpLegalRepresentative? string -

primaryContactPhone? string -

fICreditorID? string -

primaryContactTelexDescription? string -

localizationCountryRegionCode? SysLocalizationCountryRegionCode -

primaryContactFaxExtension? string -

primaryContactTelexPurpose? string -

commerceRegistration? string -

addressDistrictName? string -

partyNumber? string -

primaryContactFaxDescription? string -

primaryContactTelex? string -

languageId? string -

addressState? string -

companyCountry? string -

addressLatitude? decimal -

microsoft.dynamics365.finance.core: ListAddressBooksQueries

Represents the Queries record for the operation: listAddressBooks

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.core: ListAddressCitiesQueries

Represents the Queries record for the operation: listAddressCities

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.core: ListAddressFormatsQueries

Represents the Queries record for the operation: listAddressFormats

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.core: ListAddressObjectsQueries

Represents the Queries record for the operation: listAddressObjects

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.core: ListAddressStatesQueries

Represents the Queries record for the operation: listAddressStates

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.core: ListBranchesQueries

Represents the Queries record for the operation: listBranches

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.core: ListBusinessUnitsQueries

Represents the Queries record for the operation: listBusinessUnits

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.core: ListCDSPartiesQueries

Represents the Queries record for the operation: listCDSParties

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.core: ListCompaniesQueries

Represents the Queries record for the operation: listCompanies

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.core: ListDepartmentsQueries

Represents the Queries record for the operation: listDepartments

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.core: ListDepartmentsV2Queries

Represents the Queries record for the operation: listDepartmentsV2

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.core: 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.core: ODataCollection

Fields

odataNextLink? string -

odataCount? int -

odataContext? string -

microsoft.dynamics365.finance.core: UpdateAddressBooksHeaders

Represents the Headers record for the operation: updateAddressBooks

Fields

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

microsoft.dynamics365.finance.core: UpdateAddressCitiesHeaders

Represents the Headers record for the operation: updateAddressCities

Fields

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

microsoft.dynamics365.finance.core: UpdateAddressFormatsHeaders

Represents the Headers record for the operation: updateAddressFormats

Fields

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

microsoft.dynamics365.finance.core: UpdateAddressObjectsHeaders

Represents the Headers record for the operation: updateAddressObjects

Fields

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

microsoft.dynamics365.finance.core: UpdateAddressStatesHeaders

Represents the Headers record for the operation: updateAddressStates

Fields

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

microsoft.dynamics365.finance.core: UpdateBranchesHeaders

Represents the Headers record for the operation: updateBranches

Fields

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

microsoft.dynamics365.finance.core: UpdateBusinessUnitsHeaders

Represents the Headers record for the operation: updateBusinessUnits

Fields

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

microsoft.dynamics365.finance.core: UpdateCDSPartiesHeaders

Represents the Headers record for the operation: updateCDSParties

Fields

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

microsoft.dynamics365.finance.core: UpdateCompaniesHeaders

Represents the Headers record for the operation: updateCompanies

Fields

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

microsoft.dynamics365.finance.core: UpdateDepartmentsHeaders

Represents the Headers record for the operation: updateDepartments

Fields

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

microsoft.dynamics365.finance.core: UpdateDepartmentsV2Headers

Represents the Headers record for the operation: updateDepartmentsV2

Fields

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

Union types

microsoft.dynamics365.finance.core: DirPersonMaritalStatus

"None"|"Single"|"Married"|"Divorced"|"Widowhood"

DirPersonMaritalStatus

microsoft.dynamics365.finance.core: SysLocalizationCountryRegionCode

"Default"|"None"|"BE"|"BR"|"CA"|"CZ"|"DE"|"EE"|"ES"|"FR"|"GB"|"HU"|"IE"|"IN"|"IT"|"JP"|"LT"|"LV"|"MX"|"NL"|"NO"|"PL"|"RU"|"SA"|"TH"|"US"|"AU"|"CN"|"DK"|"FI"|"MY"|"SG"|"ZA"|"SE"|"CH"|"IS"|"AT"|"TR"

SysLocalizationCountryRegionCode

microsoft.dynamics365.finance.core: ABC

"None"|"A"|"B"|"C"

ABC

microsoft.dynamics365.finance.core: MonthsOfYear

MonthsOfYear

microsoft.dynamics365.finance.core: Timezone

Timezone

microsoft.dynamics365.finance.core: CompanyTypeMX

"Blank"|"LegalEntity"|"LegalPerson"|"ForeignCompany"

CompanyTypeMX

microsoft.dynamics365.finance.core: Gender

"Unknown"|"Male"|"Female"|"NonSpecific"

Gender

microsoft.dynamics365.finance.core: OMInternalOrganizationType

"None"|"LegalEntity"|"OperatingUnit"|"Team"

OMInternalOrganizationType

microsoft.dynamics365.finance.core: LegalNatureIT

"LN1"|"LN2"|"LN3"|"LN4"|"LN5"|"LN6"|"LN7"|"LN8"|"LN9"|"LN10"|"LN11"|"LN12"|"LN13"|"LN14"|"LN15"|"LN16"|"LN17"|"LN18"|"LN19"|"LN20"|"LN21"|"LN22"|"LN23"|"LN24"|"LN25"|"LN26"|"LN27"|"LN28"|"LN29"|"LN50"|"LN51"|"LN52"|"LN53"|"LN54"|"LN55"|"LN56"|"LN57"|"LN58"|"LN30"|"LN31"|"LN32"|"LN33"|"LN34"|"LN35"|"LN36"|"LN37"|"LN38"|"LN39"|"LN40"|"LN41"|"LN42"|"LN43"|"LN44"|"LN59"

LegalNatureIT

microsoft.dynamics365.finance.core: OMOperatingUnitType

OMOperatingUnitType

microsoft.dynamics365.finance.core: NoYes

"No"|"Yes"

NoYes

Import

import ballerinax/microsoft.dynamics365.finance.core;

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 Core

Area/Finance & Accounting

Vendor/Microsoft

Dynamics365

Finance

ERP

Type/Connector

Company

Organization

Address

Department

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

Constructor

listAddressBooks

Parameters

Return Type

createAddressBooks

Parameters

Return Type

getAddressBooks

Parameters

Return Type

deleteAddressBooks

Parameters

Return Type

updateAddressBooks

Parameters

Return Type

listAddressCities

Parameters

Return Type

createAddressCities

Parameters

Return Type

getAddressCities

Parameters

Return Type

deleteAddressCities

Parameters

Return Type

updateAddressCities

Parameters

Return Type

listAddressFormats

Parameters

Return Type

createAddressFormats

Parameters

Return Type

getAddressFormats

Parameters

Return Type

deleteAddressFormats

Parameters

Return Type

updateAddressFormats

Parameters

Return Type

listAddressObjects

Parameters

Return Type

createAddressObjects

Parameters

Return Type

getAddressObjects

Parameters

Return Type

deleteAddressObjects

Parameters

Return Type

updateAddressObjects

Parameters

Return Type