Module microsoft.dynamics365.finance.coreorg

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

Key Features

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

Step 1: Import the module


import ballerinax/microsoft.dynamics365.finance.coreorg;

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"

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


coreorg:CardTypesCollection results = check cl->listCardTypes();

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

listCardTypes

Isolated FunctionRemote Function

function listCardTypes(map<string|string[]> headers, *ListCardTypesQueries queries) returns CardTypesCollection|error

List CardTypes

Parameters

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

queries *ListCardTypesQueries - Queries to be sent with the request

Return Type

CardTypesCollection|error - Collection of CardTypes

createCardTypes

Isolated FunctionRemote Function

function createCardTypes(CardTypes payload, map<string|string[]> headers) returns CardTypes|error

Create CardTypes

Parameters

payload CardTypes - The request body

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

Return Type

CardTypes|error - CardTypes created

getCardTypes

Isolated FunctionRemote Function

function getCardTypes(string dataAreaId, string trvCreditCardType, map<string|string[]> headers, *GetCardTypesQueries queries) returns CardTypes|error

Get CardTypes by key

Parameters

dataAreaId string - The company data area identifier

trvCreditCardType string - The trv credit card type key field

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

queries *GetCardTypesQueries - Queries to be sent with the request

Return Type

CardTypes|error - CardTypes

deleteCardTypes

Isolated FunctionRemote Function

function deleteCardTypes(string dataAreaId, string trvCreditCardType, DeleteCardTypesHeaders headers) returns error?

Delete CardTypes

Parameters

dataAreaId string - The company data area identifier

trvCreditCardType string - The trv credit card type key field

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

Return Type

error? - CardTypes deleted

updateCardTypes

Isolated FunctionRemote Function

function updateCardTypes(string dataAreaId, string trvCreditCardType, CardTypes payload, UpdateCardTypesHeaders headers) returns CardTypes|error

Update CardTypes

Parameters

dataAreaId string - The company data area identifier

trvCreditCardType string - The trv credit card type key field

payload CardTypes - The request body

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

Return Type

CardTypes|error - CardTypes updated

Isolated FunctionRemote Function

function listCategories(map<string|string[]> headers, *ListCategoriesQueries queries) returns CategoriesCollection|error

List Categories

Parameters

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

queries *ListCategoriesQueries - Queries to be sent with the request

Return Type

CategoriesCollection|error - Collection of Category

createCategories

Isolated FunctionRemote Function

function createCategories(Category payload, map<string|string[]> headers) returns Category|error

Create Category

Parameters

payload Category - The request body

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

Return Type

Category|error - Category created

getCategories

Isolated FunctionRemote Function

function getCategories(string dataAreaId, string categoryId, map<string|string[]> headers, *GetCategoriesQueries queries) returns Category|error

Get Category by key

Parameters

dataAreaId string - The company data area identifier

categoryId string - The category id key field

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

queries *GetCategoriesQueries - Queries to be sent with the request

Return Type

Category|error - Category

deleteCategories

Isolated FunctionRemote Function

function deleteCategories(string dataAreaId, string categoryId, DeleteCategoriesHeaders headers) returns error?

Delete Category

Parameters

dataAreaId string - The company data area identifier

categoryId string - The category id key field

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

Return Type

error? - Category deleted

updateCategories

Isolated FunctionRemote Function

function updateCategories(string dataAreaId, string categoryId, Category payload, UpdateCategoriesHeaders headers) returns Category|error

Update Category

Parameters

dataAreaId string - The company data area identifier

categoryId string - The category id key field

payload Category - The request body

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

Return Type

Category|error - Category updated

listDirParameters

Isolated FunctionRemote Function

function listDirParameters(map<string|string[]> headers, *ListDirParametersQueries queries) returns DirParametersCollection|error

List DirParameters

Parameters

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

queries *ListDirParametersQueries - Queries to be sent with the request

Return Type

DirParametersCollection|error - Collection of DirParameters

createDirParameters

Isolated FunctionRemote Function

function createDirParameters(DirParameters payload, map<string|string[]> headers) returns DirParameters|error

Create DirParameters

Parameters

payload DirParameters - The request body

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

Return Type

DirParameters|error - DirParameters created

getDirParameters

Isolated FunctionRemote Function

function getDirParameters(int 'key, map<string|string[]> headers, *GetDirParametersQueries queries) returns DirParameters|error

Get DirParameters by key

Parameters

'key int - The entity key value

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

queries *GetDirParametersQueries - Queries to be sent with the request

Return Type

DirParameters|error - DirParameters

deleteDirParameters

Isolated FunctionRemote Function

function deleteDirParameters(int 'key, DeleteDirParametersHeaders headers) returns error?

Delete DirParameters

Parameters

'key int - The entity key value

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

Return Type

error? - DirParameters deleted

updateDirParameters

Isolated FunctionRemote Function

function updateDirParameters(int 'key, DirParameters payload, UpdateDirParametersHeaders headers) returns DirParameters|error

Update DirParameters

Parameters

'key int - The entity key value

payload DirParameters - The request body

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

Return Type

DirParameters|error - DirParameters updated

listELCOAs

Isolated FunctionRemote Function

function listELCOAs(map<string|string[]> headers, *ListELCOAsQueries queries) returns ELCOAsCollection|error

List ELCOAs

Parameters

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

queries *ListELCOAsQueries - Queries to be sent with the request

Return Type

ELCOAsCollection|error - Collection of ELCOA

createELCOAs

Isolated FunctionRemote Function

function createELCOAs(ELCOA payload, map<string|string[]> headers) returns ELCOA|error

Create ELCOA

Parameters

payload ELCOA - The request body

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

Return Type

ELCOA|error - ELCOA created

getELCOAs

Isolated FunctionRemote Function

function getELCOAs(string dataAreaId, string dimensionAttributeValueDisplayValue, map<string|string[]> headers, *GetELCOAsQueries queries) returns ELCOA|error

Get ELCOA by key

Parameters

dataAreaId string - The company data area identifier

dimensionAttributeValueDisplayValue string - The dimension attribute value display value key field

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

queries *GetELCOAsQueries - Queries to be sent with the request

Return Type

ELCOA|error - ELCOA

deleteELCOAs

Isolated FunctionRemote Function

function deleteELCOAs(string dataAreaId, string dimensionAttributeValueDisplayValue, DeleteELCOAsHeaders headers) returns error?

Delete ELCOA

Parameters

dataAreaId string - The company data area identifier

dimensionAttributeValueDisplayValue string - The dimension attribute value display value key field

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

Return Type

error? - ELCOA deleted

updateELCOAs

Isolated FunctionRemote Function

function updateELCOAs(string dataAreaId, string dimensionAttributeValueDisplayValue, ELCOA payload, UpdateELCOAsHeaders headers) returns ELCOA|error

Update ELCOA

Parameters

dataAreaId string - The company data area identifier

dimensionAttributeValueDisplayValue string - The dimension attribute value display value key field

payload ELCOA - The request body

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

Return Type

ELCOA|error - ELCOA updated

listEmplPostings

Isolated FunctionRemote Function

function listEmplPostings(map<string|string[]> headers, *ListEmplPostingsQueries queries) returns EmplPostingsCollection|error

List EmplPostings

Parameters

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

queries *ListEmplPostingsQueries - Queries to be sent with the request

Return Type

EmplPostingsCollection|error - Collection of EmplPosting

createEmplPostings

Isolated FunctionRemote Function

function createEmplPostings(EmplPosting payload, map<string|string[]> headers) returns EmplPosting|error

Create EmplPosting

Parameters

payload EmplPosting - The request body

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

Return Type

EmplPosting|error - EmplPosting created

getEmplPostings

Isolated FunctionRemote Function

function getEmplPostings(string dataAreaId, string postingProfile, string accountCode, string num, map<string|string[]> headers, *GetEmplPostingsQueries queries) returns EmplPosting|error

Get EmplPosting by key

Parameters

dataAreaId string - The company data area identifier

postingProfile string - The posting profile key field

accountCode string - The account code key field

num string - The num key field

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

queries *GetEmplPostingsQueries - Queries to be sent with the request

Return Type

EmplPosting|error - EmplPosting

deleteEmplPostings

Isolated FunctionRemote Function

function deleteEmplPostings(string dataAreaId, string postingProfile, string accountCode, string num, DeleteEmplPostingsHeaders headers) returns error?

Delete EmplPosting

Parameters

dataAreaId string - The company data area identifier

postingProfile string - The posting profile key field

accountCode string - The account code key field

num string - The num key field

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

Return Type

error? - EmplPosting deleted

updateEmplPostings

Isolated FunctionRemote Function

function updateEmplPostings(string dataAreaId, string postingProfile, string accountCode, string num, EmplPosting payload, UpdateEmplPostingsHeaders headers) returns EmplPosting|error

Update EmplPosting

Parameters

dataAreaId string - The company data area identifier

postingProfile string - The posting profile key field

accountCode string - The account code key field

num string - The num key field

payload EmplPosting - The request body

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

Return Type

EmplPosting|error - EmplPosting updated

listLanguageCodes

Isolated FunctionRemote Function

function listLanguageCodes(map<string|string[]> headers, *ListLanguageCodesQueries queries) returns LanguageCodesCollection|error

List LanguageCodes

Parameters

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

queries *ListLanguageCodesQueries - Queries to be sent with the request

Return Type

LanguageCodesCollection|error - Collection of LanguageCode

createLanguageCodes

Isolated FunctionRemote Function

function createLanguageCodes(LanguageCode payload, map<string|string[]> headers) returns LanguageCode|error

Create LanguageCode

Parameters

payload LanguageCode - The request body

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

Return Type

LanguageCode|error - LanguageCode created

getLanguageCodes

Isolated FunctionRemote Function

function getLanguageCodes(string languageCodeId, map<string|string[]> headers, *GetLanguageCodesQueries queries) returns LanguageCode|error

Get LanguageCode by key

Parameters

languageCodeId string - The language code id key field

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

queries *GetLanguageCodesQueries - Queries to be sent with the request

Return Type

LanguageCode|error - LanguageCode

deleteLanguageCodes

Isolated FunctionRemote Function

function deleteLanguageCodes(string languageCodeId, DeleteLanguageCodesHeaders headers) returns error?

Delete LanguageCode

Parameters

languageCodeId string - The language code id key field

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

Return Type

error? - LanguageCode deleted

updateLanguageCodes

Isolated FunctionRemote Function

function updateLanguageCodes(string languageCodeId, LanguageCode payload, UpdateLanguageCodesHeaders headers) returns LanguageCode|error

Update LanguageCode

Parameters

languageCodeId string - The language code id key field

payload LanguageCode - The request body

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

Return Type

LanguageCode|error - LanguageCode updated

listLegalEntities

Isolated FunctionRemote Function

function listLegalEntities(map<string|string[]> headers, *ListLegalEntitiesQueries queries) returns LegalEntitiesCollection|error

List LegalEntities

Parameters

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

queries *ListLegalEntitiesQueries - Queries to be sent with the request

Return Type

LegalEntitiesCollection|error - Collection of LegalEntity

createLegalEntities

Isolated FunctionRemote Function

function createLegalEntities(LegalEntity payload, map<string|string[]> headers) returns LegalEntity|error

Create LegalEntity

Parameters

payload LegalEntity - The request body

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

Return Type

LegalEntity|error - LegalEntity created

getLegalEntities

Isolated FunctionRemote Function

function getLegalEntities(string legalEntityId, map<string|string[]> headers, *GetLegalEntitiesQueries queries) returns LegalEntity|error

Get LegalEntity by key

Parameters

legalEntityId string - The legal entity id key field

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

queries *GetLegalEntitiesQueries - Queries to be sent with the request

Return Type

LegalEntity|error - LegalEntity

deleteLegalEntities

Isolated FunctionRemote Function

function deleteLegalEntities(string legalEntityId, DeleteLegalEntitiesHeaders headers) returns error?

Delete LegalEntity

Parameters

legalEntityId string - The legal entity id key field

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

Return Type

error? - LegalEntity deleted

updateLegalEntities

Isolated FunctionRemote Function

function updateLegalEntities(string legalEntityId, LegalEntity payload, UpdateLegalEntitiesHeaders headers) returns LegalEntity|error

Update LegalEntity

Parameters

legalEntityId string - The legal entity id key field

payload LegalEntity - The request body

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

Return Type

LegalEntity|error - LegalEntity updated

listNameAffixes

Isolated FunctionRemote Function

function listNameAffixes(map<string|string[]> headers, *ListNameAffixesQueries queries) returns NameAffixesCollection|error

List NameAffixes

Parameters

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

queries *ListNameAffixesQueries - Queries to be sent with the request

Return Type

NameAffixesCollection|error - Collection of NameAffix

createNameAffixes

Isolated FunctionRemote Function

function createNameAffixes(NameAffix payload, map<string|string[]> headers) returns NameAffix|error

Create NameAffix

Parameters

payload NameAffix - The request body

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

Return Type

NameAffix|error - NameAffix created

getNameAffixes

Isolated FunctionRemote Function

function getNameAffixes(string 'type, string affix, map<string|string[]> headers, *GetNameAffixesQueries queries) returns NameAffix|error

Get NameAffix by key

Parameters

'type string - The entity type identifier

affix string - The affix key field

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

queries *GetNameAffixesQueries - Queries to be sent with the request

Return Type

NameAffix|error - NameAffix

deleteNameAffixes

Isolated FunctionRemote Function

function deleteNameAffixes(string 'type, string affix, DeleteNameAffixesHeaders headers) returns error?

Delete NameAffix

Parameters

'type string - The entity type identifier

affix string - The affix key field

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

Return Type

error? - NameAffix deleted

updateNameAffixes

Isolated FunctionRemote Function

function updateNameAffixes(string 'type, string affix, NameAffix payload, UpdateNameAffixesHeaders headers) returns NameAffix|error

Update NameAffix

Parameters

'type string - The entity type identifier

affix string - The affix key field

payload NameAffix - The request body

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

Return Type

NameAffix|error - NameAffix updated

listNameSequences

Isolated FunctionRemote Function

function listNameSequences(map<string|string[]> headers, *ListNameSequencesQueries queries) returns NameSequencesCollection|error

List NameSequences

Parameters

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

queries *ListNameSequencesQueries - Queries to be sent with the request

Return Type

NameSequencesCollection|error - Collection of NameSequence

createNameSequences

Isolated FunctionRemote Function

function createNameSequences(NameSequence payload, map<string|string[]> headers) returns NameSequence|error

Create NameSequence

Parameters

payload NameSequence - The request body

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

Return Type

NameSequence|error - NameSequence created

getNameSequences

Isolated FunctionRemote Function

function getNameSequences(string nameSequence, string languageId, map<string|string[]> headers, *GetNameSequencesQueries queries) returns NameSequence|error

Get NameSequence by key

Parameters

nameSequence string - The name sequence key field

languageId string - The language id key field

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

queries *GetNameSequencesQueries - Queries to be sent with the request

Return Type

NameSequence|error - NameSequence

deleteNameSequences

Isolated FunctionRemote Function

function deleteNameSequences(string nameSequence, string languageId, DeleteNameSequencesHeaders headers) returns error?

Delete NameSequence

Parameters

nameSequence string - The name sequence key field

languageId string - The language id key field

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

Return Type

error? - NameSequence deleted

updateNameSequences

Isolated FunctionRemote Function

function updateNameSequences(string nameSequence, string languageId, NameSequence payload, UpdateNameSequencesHeaders headers) returns NameSequence|error

Update NameSequence

Parameters

nameSequence string - The name sequence key field

languageId string - The language id key field

payload NameSequence - The request body

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

Return Type

NameSequence|error - NameSequence updated

listSalutations

Isolated FunctionRemote Function

function listSalutations(map<string|string[]> headers, *ListSalutationsQueries queries) returns SalutationsCollection|error

List Salutations

Parameters

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

queries *ListSalutationsQueries - Queries to be sent with the request

Return Type

SalutationsCollection|error - Collection of Salutation

createSalutations

Isolated FunctionRemote Function

function createSalutations(Salutation payload, map<string|string[]> headers) returns Salutation|error

Create Salutation

Parameters

payload Salutation - The request body

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

Return Type

Salutation|error - Salutation created

getSalutations

Isolated FunctionRemote Function

function getSalutations(string dataAreaId, string salutationPhrase, map<string|string[]> headers, *GetSalutationsQueries queries) returns Salutation|error

Get Salutation by key

Parameters

dataAreaId string - The company data area identifier

salutationPhrase string - The salutation phrase key field

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

queries *GetSalutationsQueries - Queries to be sent with the request

Return Type

Salutation|error - Salutation

deleteSalutations

Isolated FunctionRemote Function

function deleteSalutations(string dataAreaId, string salutationPhrase, DeleteSalutationsHeaders headers) returns error?

Delete Salutation

Parameters

dataAreaId string - The company data area identifier

salutationPhrase string - The salutation phrase key field

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

Return Type

error? - Salutation deleted

updateSalutations

Isolated FunctionRemote Function

function updateSalutations(string dataAreaId, string salutationPhrase, Salutation payload, UpdateSalutationsHeaders headers) returns Salutation|error

Update Salutation

Parameters

dataAreaId string - The company data area identifier

salutationPhrase string - The salutation phrase key field

payload Salutation - The request body

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

Return Type

Salutation|error - Salutation updated

listVATNumTables

Isolated FunctionRemote Function

function listVATNumTables(map<string|string[]> headers, *ListVATNumTablesQueries queries) returns VATNumTablesCollection|error

List VATNumTables

Parameters

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

queries *ListVATNumTablesQueries - Queries to be sent with the request

Return Type

VATNumTablesCollection|error - Collection of VATNumTable

createVATNumTables

Isolated FunctionRemote Function

function createVATNumTables(VATNumTable payload, map<string|string[]> headers) returns VATNumTable|error

Create VATNumTable

Parameters

payload VATNumTable - The request body

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

Return Type

VATNumTable|error - VATNumTable created

getVATNumTables

Isolated FunctionRemote Function

function getVATNumTables(string dataAreaId, string vATNum, string countryRegionId, map<string|string[]> headers, *GetVATNumTablesQueries queries) returns VATNumTable|error

Get VATNumTable by key

Parameters

dataAreaId string - The company data area identifier

vATNum string - The v at num key field

countryRegionId string - The country region id key field

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

queries *GetVATNumTablesQueries - Queries to be sent with the request

Return Type

VATNumTable|error - VATNumTable

deleteVATNumTables

Isolated FunctionRemote Function

function deleteVATNumTables(string dataAreaId, string vATNum, string countryRegionId, DeleteVATNumTablesHeaders headers) returns error?

Delete VATNumTable

Parameters

dataAreaId string - The company data area identifier

vATNum string - The v at num key field

countryRegionId string - The country region id key field

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

Return Type

error? - VATNumTable deleted

updateVATNumTables

Isolated FunctionRemote Function

function updateVATNumTables(string dataAreaId, string vATNum, string countryRegionId, VATNumTable payload, UpdateVATNumTablesHeaders headers) returns VATNumTable|error

Update VATNumTable

Parameters

dataAreaId string - The company data area identifier

vATNum string - The v at num key field

countryRegionId string - The country region id key field

payload VATNumTable - The request body

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

Return Type

VATNumTable|error - VATNumTable updated

listWarehouses

Isolated FunctionRemote Function

function listWarehouses(map<string|string[]> headers, *ListWarehousesQueries queries) returns WarehousesCollection|error

List Warehouses

Parameters

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

queries *ListWarehousesQueries - Queries to be sent with the request

Return Type

WarehousesCollection|error - Collection of Warehouse

createWarehouses

Isolated FunctionRemote Function

function createWarehouses(Warehouse payload, map<string|string[]> headers) returns Warehouse|error

Create Warehouse

Parameters

payload Warehouse - The request body

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

Return Type

Warehouse|error - Warehouse created

getWarehouses

Isolated FunctionRemote Function

function getWarehouses(string dataAreaId, string warehouseId, map<string|string[]> headers, *GetWarehousesQueries queries) returns Warehouse|error

Get Warehouse by key

Parameters

dataAreaId string - The company data area identifier

warehouseId string - The warehouse id key field

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

queries *GetWarehousesQueries - Queries to be sent with the request

Return Type

Warehouse|error - Warehouse

deleteWarehouses

Isolated FunctionRemote Function

function deleteWarehouses(string dataAreaId, string warehouseId, DeleteWarehousesHeaders headers) returns error?

Delete Warehouse

Parameters

dataAreaId string - The company data area identifier

warehouseId string - The warehouse id key field

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

Return Type

error? - Warehouse deleted

updateWarehouses

Isolated FunctionRemote Function

function updateWarehouses(string dataAreaId, string warehouseId, Warehouse payload, UpdateWarehousesHeaders headers) returns Warehouse|error

Update Warehouse

Parameters

dataAreaId string - The company data area identifier

warehouseId string - The warehouse id key field

payload Warehouse - The request body

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

Return Type

Warehouse|error - Warehouse updated

Records

microsoft.dynamics365.finance.coreorg: AddressBooks

Fields

description? string -

system? NoYes -

name? string -

microsoft.dynamics365.finance.coreorg: 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.coreorg: AddressState

Fields

brazilStateCode? string -

timeZone? Timezone -

defaultStateForCountryRegion? NoYes -

countryRegionId? string -

state? string -

intrastatCode? string -

name? string -

microsoft.dynamics365.finance.coreorg: CardTypes

Fields

dataAreaId? string -

trvCreditCardType? string -

trvCreditCardDesc? string -

microsoft.dynamics365.finance.coreorg: CardTypesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *CardTypesCollectionAllOf2

value CardTypes[]
anydata...

microsoft.dynamics365.finance.coreorg: CardTypesCollectionAllOf2

Fields

value? CardTypes[] -

microsoft.dynamics365.finance.coreorg: CategoriesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *CategoriesCollectionAllOf2

value Category[]
anydata...

microsoft.dynamics365.finance.coreorg: CategoriesCollectionAllOf2

Fields

value? Category[] -

microsoft.dynamics365.finance.coreorg: Category

Fields

categoryId? string -

dataAreaId? string -

useInProject? NoYes -

useInExpense? NoYes -

categoryName? string -

sharedCategoryId? string -

useInProduction? NoYes -

microsoft.dynamics365.finance.coreorg: 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.coreorg: DeleteCardTypesHeaders

Represents the Headers record for the operation: deleteCardTypes

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteCategoriesHeaders

Represents the Headers record for the operation: deleteCategories

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteDirParametersHeaders

Represents the Headers record for the operation: deleteDirParameters

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteELCOAsHeaders

Represents the Headers record for the operation: deleteELCOAs

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteEmplPostingsHeaders

Represents the Headers record for the operation: deleteEmplPostings

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteLanguageCodesHeaders

Represents the Headers record for the operation: deleteLanguageCodes

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteLegalEntitiesHeaders

Represents the Headers record for the operation: deleteLegalEntities

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteNameAffixesHeaders

Represents the Headers record for the operation: deleteNameAffixes

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteNameSequencesHeaders

Represents the Headers record for the operation: deleteNameSequences

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteSalutationsHeaders

Represents the Headers record for the operation: deleteSalutations

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteVATNumTablesHeaders

Represents the Headers record for the operation: deleteVATNumTables

Fields

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

microsoft.dynamics365.finance.coreorg: DeleteWarehousesHeaders

Represents the Headers record for the operation: deleteWarehouses

Fields

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

microsoft.dynamics365.finance.coreorg: DirParameters

Fields

deletePartiesWithNoRole? NoYes -

dunsDisplayOnAddress? NoYes -

enableEditForExternallyMaintainedFields? NoYes -

enableSystemRelationships? NoYes -

useDuplicateCheck? NoYes -

dunsCheckUnique? NoYes -

defaultPartyType? DirPartyBaseType -

enableEmailAddressFieldValidation? NoYes -

nameSequence? string -

key? Signed32 -

microsoft.dynamics365.finance.coreorg: DirParametersCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *DirParametersCollectionAllOf2

value DirParameters[]
anydata...

microsoft.dynamics365.finance.coreorg: DirParametersCollectionAllOf2

Fields

value? DirParameters[] -

microsoft.dynamics365.finance.coreorg: ELCOA

Fields

dataAreaId? string -

groupCodeDescription? string -

dimensionAttributeValueDisplayValue? string -

groupCode? string -

mainAccountDescription? string -

mainAccountNum? string -

microsoft.dynamics365.finance.coreorg: ELCOAsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ELCOAsCollectionAllOf2

value ELCOA[]
anydata...

microsoft.dynamics365.finance.coreorg: ELCOAsCollectionAllOf2

Fields

value? ELCOA[] -

microsoft.dynamics365.finance.coreorg: EmplPosting

Fields

dataAreaId? string -

summaryLedgerDimensionDisplayValue? string -

postingProfile? string -

num? string -

accountCode? TableGroupAll -

settlementByDimension? DimSettlementCtrlTypeRU -

name? string -

microsoft.dynamics365.finance.coreorg: EmplPostingsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *EmplPostingsCollectionAllOf2

value EmplPosting[]
anydata...

microsoft.dynamics365.finance.coreorg: EmplPostingsCollectionAllOf2

Fields

value? EmplPosting[] -

microsoft.dynamics365.finance.coreorg: GetCardTypesQueries

Represents the Queries record for the operation: getCardTypes

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.coreorg: GetCategoriesQueries

Represents the Queries record for the operation: getCategories

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.coreorg: GetDirParametersQueries

Represents the Queries record for the operation: getDirParameters

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.coreorg: GetELCOAsQueries

Represents the Queries record for the operation: getELCOAs

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.coreorg: GetEmplPostingsQueries

Represents the Queries record for the operation: getEmplPostings

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.coreorg: GetLanguageCodesQueries

Represents the Queries record for the operation: getLanguageCodes

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.coreorg: GetLegalEntitiesQueries

Represents the Queries record for the operation: getLegalEntities

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.coreorg: GetNameAffixesQueries

Represents the Queries record for the operation: getNameAffixes

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.coreorg: GetNameSequencesQueries

Represents the Queries record for the operation: getNameSequences

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.coreorg: GetSalutationsQueries

Represents the Queries record for the operation: getSalutations

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.coreorg: GetVATNumTablesQueries

Represents the Queries record for the operation: getVATNumTables

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.coreorg: GetWarehousesQueries

Represents the Queries record for the operation: getWarehouses

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.coreorg: LanguageCode

Fields

languageCodeId? string -

description? string -

microsoft.dynamics365.finance.coreorg: LanguageCodesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *LanguageCodesCollectionAllOf2

value LanguageCode[]
anydata...

microsoft.dynamics365.finance.coreorg: LanguageCodesCollectionAllOf2

Fields

value? LanguageCode[] -

microsoft.dynamics365.finance.coreorg: LegalEntitiesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *LegalEntitiesCollectionAllOf2

value LegalEntity[]
anydata...

microsoft.dynamics365.finance.coreorg: LegalEntitiesCollectionAllOf2

Fields

value? LegalEntity[] -

microsoft.dynamics365.finance.coreorg: 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.coreorg: ListCardTypesQueries

Represents the Queries record for the operation: listCardTypes

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.coreorg: ListCategoriesQueries

Represents the Queries record for the operation: listCategories

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.coreorg: ListDirParametersQueries

Represents the Queries record for the operation: listDirParameters

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.coreorg: ListELCOAsQueries

Represents the Queries record for the operation: listELCOAs

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.coreorg: ListEmplPostingsQueries

Represents the Queries record for the operation: listEmplPostings

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.coreorg: ListLanguageCodesQueries

Represents the Queries record for the operation: listLanguageCodes

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.coreorg: ListLegalEntitiesQueries

Represents the Queries record for the operation: listLegalEntities

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.coreorg: ListNameAffixesQueries

Represents the Queries record for the operation: listNameAffixes

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.coreorg: ListNameSequencesQueries

Represents the Queries record for the operation: listNameSequences

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.coreorg: ListSalutationsQueries

Represents the Queries record for the operation: listSalutations

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.coreorg: ListVATNumTablesQueries

Represents the Queries record for the operation: listVATNumTables

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.coreorg: ListWarehousesQueries

Represents the Queries record for the operation: listWarehouses

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.coreorg: NameAffix

Fields

'type? DirNameAffixType -

affix? string -

description? string -

microsoft.dynamics365.finance.coreorg: NameAffixesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *NameAffixesCollectionAllOf2

value NameAffix[]
anydata...

microsoft.dynamics365.finance.coreorg: NameAffixesCollectionAllOf2

Fields

value? NameAffix[] -

microsoft.dynamics365.finance.coreorg: NameSequence

Fields

thirdPosition? DirSubNameSequenceType -

description? string -

separator3Spaces? Signed32 -

separator1Spaces? Signed32 -

separator2? string -

separator1? string -

separator3? string -

firstPosition? DirSubNameSequenceType -

separator2Spaces? Signed32 -

lastPosition? DirSubNameSequenceType -

secondPosition? DirSubNameSequenceType -

nameSequence? string -

languageId? string -

microsoft.dynamics365.finance.coreorg: NameSequencesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *NameSequencesCollectionAllOf2

value NameSequence[]
anydata...

microsoft.dynamics365.finance.coreorg: NameSequencesCollectionAllOf2

Fields

value? NameSequence[] -

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

Fields

odataNextLink? string -

odataCount? int -

odataContext? string -

microsoft.dynamics365.finance.coreorg: Salutation

Fields

dataAreaId? string -

salutationPhrase? string -

microsoft.dynamics365.finance.coreorg: SalutationsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *SalutationsCollectionAllOf2

value Salutation[]
anydata...

microsoft.dynamics365.finance.coreorg: SalutationsCollectionAllOf2

Fields

value? Salutation[] -

microsoft.dynamics365.finance.coreorg: UpdateCardTypesHeaders

Represents the Headers record for the operation: updateCardTypes

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateCategoriesHeaders

Represents the Headers record for the operation: updateCategories

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateDirParametersHeaders

Represents the Headers record for the operation: updateDirParameters

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateELCOAsHeaders

Represents the Headers record for the operation: updateELCOAs

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateEmplPostingsHeaders

Represents the Headers record for the operation: updateEmplPostings

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateLanguageCodesHeaders

Represents the Headers record for the operation: updateLanguageCodes

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateLegalEntitiesHeaders

Represents the Headers record for the operation: updateLegalEntities

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateNameAffixesHeaders

Represents the Headers record for the operation: updateNameAffixes

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateNameSequencesHeaders

Represents the Headers record for the operation: updateNameSequences

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateSalutationsHeaders

Represents the Headers record for the operation: updateSalutations

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateVATNumTablesHeaders

Represents the Headers record for the operation: updateVATNumTables

Fields

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

microsoft.dynamics365.finance.coreorg: UpdateWarehousesHeaders

Represents the Headers record for the operation: updateWarehouses

Fields

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

microsoft.dynamics365.finance.coreorg: VATNumTable

Fields

dataAreaId? string -

vATNum? string -

countryRegionId? string -

name? string -

microsoft.dynamics365.finance.coreorg: VATNumTablesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *VATNumTablesCollectionAllOf2

value VATNumTable[]
anydata...

microsoft.dynamics365.finance.coreorg: VATNumTablesCollectionAllOf2

Fields

value? VATNumTable[] -

microsoft.dynamics365.finance.coreorg: Warehouse

Fields

willShippingCancellationDecrementLoadQuanity? NoYes -

goodsInTransitWarehouseId? string -

primaryAddressCityInKana? string -

isBillOfLadingPrintingBeforeShipmentConfirmationEnabled? NoYes -

rawMaterialPickingInventoryIssueStatus? WHSRawMaterialPolicy -

willProductionBOMsReserveWarehouseLevelOnly? NoYes -

willInventoryStatusChangeRemoveBlocking? NoYes -

numberSequenceGroupRU? string -

masterPlanningWorkCalendardId? string -

languageUsedForExportHazardousMaterialsShippingDocuments? string -

warehouseReleaseReservationRequirementRule? WHSReleaseToWarehouseRule -

warehouseName? string -

underdeliveryWarehouseId? string -

defaultContainerTypeId? string -

dataAreaId? string -

isWarehouseExternallyManaged? NoYes -

primaryAddressLocationSalesTaxGroupCode? string -

identificationGroup? InventCountingGroupBR -

shouldWarehouseLocationIdIncludeAisleId? NoYes -

maximumPickingListLineQuantity? Signed32 -

primaryAddressDescription? string -

willWarehouseLocationIdIncludeBinIdByDefault? NoYes -

arePickingListsShipmentSpecificOnly? NoYes -

primaryAddressStreetNumber? string -

retailStoreQuantityAllocationReplenismentRuleWeight? decimal -

willAutomaticLoadReleaseReserveInventory? NoYes -

primaryAddressPostBox? string -

primaryAddressCity? string -

coordinatesRetrievalStrategy? WHSCoordinatesRetrievalStrategy -

isFallbackWarehouse? NoYes -

inventProfileTypeRU? InventProfileTypeRU -

externallyLocatedWarehouseVendorAccountNumber? string -

formattedPrimaryAddress? string -

reportAsFinishedPostingMethod? ProdRAFPostingMethodInherit -

activityTypeRU? string -

isFinancialNegativeRetailStoreInventoryAllowed? NoYes -

warehouseReleaseReservationRequirementRuleFailureOption? WHSReleaseRuleFailureOption -

languageUsedForDomesticHazardousMaterialsShippingDocuments? string -

primaryAddressCountyId? string -

primaryAddressDistrictName? string -

externalWarehouseId? string -

primaryAddressLongitude? decimal -

isPhysicalNegativeRetailStoreInventoryAllowed? NoYes -

inventoryStatusChangeReservationRemovalLevel? WHSAllowMarkingReservationRemoval -

areAdvancedWarehouseManagementProcessesEnabled? NoYes -

externalWarehouseManagementSystemId? string -

isPrimaryAddressAssigned? NoYes -

warehouseType? InventLocationType -

quarantineWarehouseId? string -

areItemsCoveragePlannedManually? NoYes -

inventLocationIdGoodsInRouteRU? string -

distanceCalculationStrategy? WHSDistanceCalculationStrategy -

primaryAddressStreet? string -

primaryAddressTimeZone? Timezone -

willManualLoadReleaseReserveInventory? NoYes -

areLaborStandardsAllowed? NoYes -

operationalSiteId? string -

warehouseLocationIdBinIdFormat? string -

wMSLocationIdGoodsInRouteRU? string -

rBODefaultInventProfileIdRU? string -

inventProfileIdRU? string -

warehouseLocationIdRackIdFormat? string -

warehouseLocationIdShelfIdFormat? string -

willOrderReleasingConsolidateShipments? NoYes -

primaryAddressBuildingCompliment? string -

willWarehouseLocationIdIncludeShelfIdByDefault? NoYes -

externallyLocatedWarehouseCustomerAccountNumber? string -

mainRefillingWarehouseId? string -

maximumBatchPickingListQuantity? Signed32 -

primaryAddressStateId? string -

vendAccountCustomRU? string -

isRefilledFromMainWarehouse? NoYes -

loadReleaseReservationPolicyRule? WHSLoadReleaseReservationPolicy -

isPalletMovementDuringCycleCountingAllowed? NoYes -

spatialLocationSortingStrategy? WHSSpatialLocationSortingStrategy -

willWarehouseLocationIdIncludeRackIdByDefault? NoYes -

transitWarehouseId? string -

autoUpdateShipmentRule? WHSAutoUpdateShipment -

warehouseId? string -

isRetailStoreWarehouse? NoYes -

externalWarehouseDefaultLocationId? string -

primaryAddressLatitude? decimal -

warehouseSpecificDefaultInventoryStatusId? string -

primaryAddressStreetInKana? string -

areWarehouseLocationCheckDigitsUnique? NoYes -

externalWarehouseDefaultLicensePlateLocationId? string -

inventoryCountingReasonCodePolicyName? string -

arePickingListsDeliveryModeSpecific? NoYes -

primaryAddressCountryRegionId? string -

warehouseWorkProcessingPolicyName? string -

primaryAddressLocationRoles? string -

primaryAddressZipCode? string -

microsoft.dynamics365.finance.coreorg: WarehousesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *WarehousesCollectionAllOf2

value Warehouse[]
anydata...

microsoft.dynamics365.finance.coreorg: WarehousesCollectionAllOf2

Fields

value? Warehouse[] -

Union types

microsoft.dynamics365.finance.coreorg: ProdRAFPostingMethodInherit

"Inherit"|"Immediate"|"Deferred"

ProdRAFPostingMethodInherit

microsoft.dynamics365.finance.coreorg: InventProfileTypeRU

"NotSpecified"|"General"|"CommissionAgent"|"CommissionPrincipalAgent"|"Bailee"

InventProfileTypeRU

microsoft.dynamics365.finance.coreorg: WHSAutoUpdateShipment

"OnQuantityDecrease"|"Always"

WHSAutoUpdateShipment

microsoft.dynamics365.finance.coreorg: WHSReleaseToWarehouseRule

"NotApplicable"|"AllowPartialReservation"|"RequireFullReservation"

WHSReleaseToWarehouseRule

microsoft.dynamics365.finance.coreorg: 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.coreorg: InventLocationType

InventLocationType

microsoft.dynamics365.finance.coreorg: WHSDistanceCalculationStrategy

"StraightLine"|"CityBlock"

WHSDistanceCalculationStrategy

microsoft.dynamics365.finance.coreorg: DirSubNameSequenceType

DirSubNameSequenceType

microsoft.dynamics365.finance.coreorg: WHSLoadReleaseReservationPolicy

"Error"|"Warning"

WHSLoadReleaseReservationPolicy

microsoft.dynamics365.finance.coreorg: WHSAllowMarkingReservationRemoval

"None"|"Reservation"|"MarkingReservation"

WHSAllowMarkingReservationRemoval

microsoft.dynamics365.finance.coreorg: InventCountingGroupBR

"OwnStockInOtherPower"|"OwnStock"|"OtherStock"

InventCountingGroupBR

microsoft.dynamics365.finance.coreorg: DimSettlementCtrlTypeRU

"None"|"Auto"|"Manual"|"Always"

DimSettlementCtrlTypeRU

microsoft.dynamics365.finance.coreorg: DirPartyBaseType

"Person"|"Organization"

DirPartyBaseType

microsoft.dynamics365.finance.coreorg: DirNameAffixType

"PersonalPrefix"|"PersonalSuffix"

DirNameAffixType

microsoft.dynamics365.finance.coreorg: Timezone

Timezone

microsoft.dynamics365.finance.coreorg: CompanyTypeMX

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

CompanyTypeMX

microsoft.dynamics365.finance.coreorg: 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.coreorg: TableGroupAll

"Table"|"GroupId"|"All"

TableGroupAll

microsoft.dynamics365.finance.coreorg: WHSSpatialLocationSortingStrategy

"FastCalculation"|"OptimizedRoute"

WHSSpatialLocationSortingStrategy

microsoft.dynamics365.finance.coreorg: WHSRawMaterialPolicy

"Pick"|"Reserve"

WHSRawMaterialPolicy

microsoft.dynamics365.finance.coreorg: NoYes

"No"|"Yes"

NoYes

microsoft.dynamics365.finance.coreorg: WHSReleaseRuleFailureOption

"WarningSkipLine"|"ErrorSkipOrder"

WHSReleaseRuleFailureOption

Import

import ballerinax/microsoft.dynamics365.finance.coreorg;

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 Organization

Area/Finance & Accounting

Vendor/Microsoft

Dynamics365

Finance

ERP

Type/Connector

LegalEntity

Warehouse

Organization

Reference

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

Constructor

listCardTypes

Parameters

Return Type

createCardTypes

Parameters

Return Type

getCardTypes

Parameters

Return Type

deleteCardTypes

Parameters

Return Type

updateCardTypes

Parameters

Return Type

listCategories

Parameters

Return Type

createCategories

Parameters

Return Type

getCategories

Parameters

Return Type

deleteCategories

Parameters

Return Type

updateCategories

Parameters

Return Type

listDirParameters

Parameters

Return Type

createDirParameters

Parameters

Return Type

getDirParameters

Parameters

Return Type

deleteDirParameters

Parameters

Return Type

updateDirParameters

Parameters

Return Type

listELCOAs

Parameters

Return Type

createELCOAs

Parameters

Return Type

getELCOAs

Parameters

Return Type

deleteELCOAs

Parameters

Return Type

updateELCOAs

Parameters

Return Type