microsoft.dynamics365.finance.hr
Module microsoft.dynamics365.finance.hr
API
Definitions
ballerinax/microsoft.dynamics365.finance.hr Ballerina library
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.hr connector provides access to Microsoft Dynamics 365 Finance Human Resources entities via the OData REST API.
Key Features
- Manage human resources 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 theuser_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.hr connector in your Ballerina application, modify the .bal file as follows:
Step 1: Import the module
import ballerinax/microsoft.dynamics365.finance.hr;
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" hr: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
hr:AbsenceCodesCollection results = check cl->listAbsenceCodes();
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.hr: Client
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
listAbsenceCodes
function listAbsenceCodes(map<string|string[]> headers, *ListAbsenceCodesQueries queries) returns AbsenceCodesCollection|errorList AbsenceCodes
Parameters
- queries *ListAbsenceCodesQueries - Queries to be sent with the request
Return Type
- AbsenceCodesCollection|error - Collection of AbsenceCode
createAbsenceCodes
function createAbsenceCodes(AbsenceCode payload, map<string|string[]> headers) returns AbsenceCode|errorCreate AbsenceCode
Parameters
- payload AbsenceCode - The request body
Return Type
- AbsenceCode|error - AbsenceCode created
getAbsenceCodes
function getAbsenceCodes(string dataAreaId, string absenceCode, map<string|string[]> headers, *GetAbsenceCodesQueries queries) returns AbsenceCode|errorGet AbsenceCode by key
Parameters
- dataAreaId string - The company data area identifier
- absenceCode string - The absence code key field
- queries *GetAbsenceCodesQueries - Queries to be sent with the request
Return Type
- AbsenceCode|error - AbsenceCode
deleteAbsenceCodes
function deleteAbsenceCodes(string dataAreaId, string absenceCode, DeleteAbsenceCodesHeaders headers) returns error?Delete AbsenceCode
Parameters
- dataAreaId string - The company data area identifier
- absenceCode string - The absence code key field
- headers DeleteAbsenceCodesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - AbsenceCode deleted
updateAbsenceCodes
function updateAbsenceCodes(string dataAreaId, string absenceCode, AbsenceCode payload, UpdateAbsenceCodesHeaders headers) returns AbsenceCode|errorUpdate AbsenceCode
Parameters
- dataAreaId string - The company data area identifier
- absenceCode string - The absence code key field
- payload AbsenceCode - The request body
- headers UpdateAbsenceCodesHeaders (default {}) - Headers to be sent with the request
Return Type
- AbsenceCode|error - AbsenceCode updated
listAbsenceReasons
function listAbsenceReasons(map<string|string[]> headers, *ListAbsenceReasonsQueries queries) returns AbsenceReasonsCollection|errorList AbsenceReasons
Parameters
- queries *ListAbsenceReasonsQueries - Queries to be sent with the request
Return Type
- AbsenceReasonsCollection|error - Collection of AbsenceReason
createAbsenceReasons
function createAbsenceReasons(AbsenceReason payload, map<string|string[]> headers) returns AbsenceReason|errorCreate AbsenceReason
Parameters
- payload AbsenceReason - The request body
Return Type
- AbsenceReason|error - AbsenceReason created
getAbsenceReasons
function getAbsenceReasons(string dataAreaId, string absenceCode, string reasonCodeId, map<string|string[]> headers, *GetAbsenceReasonsQueries queries) returns AbsenceReason|errorGet AbsenceReason by key
Parameters
- dataAreaId string - The company data area identifier
- absenceCode string - The absence code key field
- reasonCodeId string - The reason code id key field
- queries *GetAbsenceReasonsQueries - Queries to be sent with the request
Return Type
- AbsenceReason|error - AbsenceReason
deleteAbsenceReasons
function deleteAbsenceReasons(string dataAreaId, string absenceCode, string reasonCodeId, DeleteAbsenceReasonsHeaders headers) returns error?Delete AbsenceReason
Parameters
- dataAreaId string - The company data area identifier
- absenceCode string - The absence code key field
- reasonCodeId string - The reason code id key field
- headers DeleteAbsenceReasonsHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - AbsenceReason deleted
updateAbsenceReasons
function updateAbsenceReasons(string dataAreaId, string absenceCode, string reasonCodeId, AbsenceReason payload, UpdateAbsenceReasonsHeaders headers) returns AbsenceReason|errorUpdate AbsenceReason
Parameters
- dataAreaId string - The company data area identifier
- absenceCode string - The absence code key field
- reasonCodeId string - The reason code id key field
- payload AbsenceReason - The request body
- headers UpdateAbsenceReasonsHeaders (default {}) - Headers to be sent with the request
Return Type
- AbsenceReason|error - AbsenceReason updated
listCityHolidays
function listCityHolidays(map<string|string[]> headers, *ListCityHolidaysQueries queries) returns CityHolidaysCollection|errorList CityHolidays
Parameters
- queries *ListCityHolidaysQueries - Queries to be sent with the request
Return Type
- CityHolidaysCollection|error - Collection of CityHoliday
createCityHolidays
function createCityHolidays(CityHoliday payload, map<string|string[]> headers) returns CityHoliday|errorCreate CityHoliday
Parameters
- payload CityHoliday - The request body
Return Type
- CityHoliday|error - CityHoliday created
getCityHolidays
function getCityHolidays(string countryRegionId, string stateId, string cityName, string holidayDate, map<string|string[]> headers, *GetCityHolidaysQueries queries) returns CityHoliday|errorGet CityHoliday by key
Parameters
- countryRegionId string - The country region id key field
- stateId string - The state id key field
- cityName string - The city name key field
- holidayDate string - The holiday date key field
- queries *GetCityHolidaysQueries - Queries to be sent with the request
Return Type
- CityHoliday|error - CityHoliday
deleteCityHolidays
function deleteCityHolidays(string countryRegionId, string stateId, string cityName, string holidayDate, DeleteCityHolidaysHeaders headers) returns error?Delete CityHoliday
Parameters
- countryRegionId string - The country region id key field
- stateId string - The state id key field
- cityName string - The city name key field
- holidayDate string - The holiday date key field
- headers DeleteCityHolidaysHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - CityHoliday deleted
updateCityHolidays
function updateCityHolidays(string countryRegionId, string stateId, string cityName, string holidayDate, CityHoliday payload, UpdateCityHolidaysHeaders headers) returns CityHoliday|errorUpdate CityHoliday
Parameters
- countryRegionId string - The country region id key field
- stateId string - The state id key field
- cityName string - The city name key field
- holidayDate string - The holiday date key field
- payload CityHoliday - The request body
- headers UpdateCityHolidaysHeaders (default {}) - Headers to be sent with the request
Return Type
- CityHoliday|error - CityHoliday updated
listEmployments
function listEmployments(map<string|string[]> headers, *ListEmploymentsQueries queries) returns EmploymentsCollection|errorList Employments
Parameters
- queries *ListEmploymentsQueries - Queries to be sent with the request
Return Type
- EmploymentsCollection|error - Collection of Employment
createEmployments
function createEmployments(Employment payload, map<string|string[]> headers) returns Employment|errorCreate Employment
Parameters
- payload Employment - The request body
Return Type
- Employment|error - Employment created
getEmployments
function getEmployments(string personnelNumber, string legalEntityId, string employmentStartDate, string employmentEndDate, map<string|string[]> headers, *GetEmploymentsQueries queries) returns Employment|errorGet Employment by key
Parameters
- personnelNumber string - The personnel number key field
- legalEntityId string - The legal entity id key field
- employmentStartDate string - The employment start date key field
- employmentEndDate string - The employment end date key field
- queries *GetEmploymentsQueries - Queries to be sent with the request
Return Type
- Employment|error - Employment
deleteEmployments
function deleteEmployments(string personnelNumber, string legalEntityId, string employmentStartDate, string employmentEndDate, DeleteEmploymentsHeaders headers) returns error?Delete Employment
Parameters
- personnelNumber string - The personnel number key field
- legalEntityId string - The legal entity id key field
- employmentStartDate string - The employment start date key field
- employmentEndDate string - The employment end date key field
- headers DeleteEmploymentsHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - Employment deleted
updateEmployments
function updateEmployments(string personnelNumber, string legalEntityId, string employmentStartDate, string employmentEndDate, Employment payload, UpdateEmploymentsHeaders headers) returns Employment|errorUpdate Employment
Parameters
- personnelNumber string - The personnel number key field
- legalEntityId string - The legal entity id key field
- employmentStartDate string - The employment start date key field
- employmentEndDate string - The employment end date key field
- payload Employment - The request body
- headers UpdateEmploymentsHeaders (default {}) - Headers to be sent with the request
Return Type
- Employment|error - Employment updated
listEssWorkers
function listEssWorkers(map<string|string[]> headers, *ListEssWorkersQueries queries) returns EssWorkersCollection|errorList EssWorkers
Parameters
- queries *ListEssWorkersQueries - Queries to be sent with the request
Return Type
- EssWorkersCollection|error - Collection of EssWorker
createEssWorkers
Create EssWorker
Parameters
- payload EssWorker - The request body
getEssWorkers
function getEssWorkers(string personnelNumber, map<string|string[]> headers, *GetEssWorkersQueries queries) returns EssWorker|errorGet EssWorker by key
Parameters
- personnelNumber string - The personnel number key field
- queries *GetEssWorkersQueries - Queries to be sent with the request
deleteEssWorkers
function deleteEssWorkers(string personnelNumber, DeleteEssWorkersHeaders headers) returns error?Delete EssWorker
Parameters
- personnelNumber string - The personnel number key field
- headers DeleteEssWorkersHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - EssWorker deleted
updateEssWorkers
function updateEssWorkers(string personnelNumber, EssWorker payload, UpdateEssWorkersHeaders headers) returns EssWorker|errorUpdate EssWorker
Parameters
- personnelNumber string - The personnel number key field
- payload EssWorker - The request body
- headers UpdateEssWorkersHeaders (default {}) - Headers to be sent with the request
listInjuryTypes
function listInjuryTypes(map<string|string[]> headers, *ListInjuryTypesQueries queries) returns InjuryTypesCollection|errorList InjuryTypes
Parameters
- queries *ListInjuryTypesQueries - Queries to be sent with the request
Return Type
- InjuryTypesCollection|error - Collection of InjuryType
createInjuryTypes
function createInjuryTypes(InjuryType payload, map<string|string[]> headers) returns InjuryType|errorCreate InjuryType
Parameters
- payload InjuryType - The request body
Return Type
- InjuryType|error - InjuryType created
getInjuryTypes
function getInjuryTypes(string injuryTypeId, map<string|string[]> headers, *GetInjuryTypesQueries queries) returns InjuryType|errorGet InjuryType by key
Parameters
- injuryTypeId string - The injury type id key field
- queries *GetInjuryTypesQueries - Queries to be sent with the request
Return Type
- InjuryType|error - InjuryType
deleteInjuryTypes
function deleteInjuryTypes(string injuryTypeId, DeleteInjuryTypesHeaders headers) returns error?Delete InjuryType
Parameters
- injuryTypeId string - The injury type id key field
- headers DeleteInjuryTypesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - InjuryType deleted
updateInjuryTypes
function updateInjuryTypes(string injuryTypeId, InjuryType payload, UpdateInjuryTypesHeaders headers) returns InjuryType|errorUpdate InjuryType
Parameters
- injuryTypeId string - The injury type id key field
- payload InjuryType - The request body
- headers UpdateInjuryTypesHeaders (default {}) - Headers to be sent with the request
Return Type
- InjuryType|error - InjuryType updated
listPeople
function listPeople(map<string|string[]> headers, *ListPeopleQueries queries) returns PeopleCollection|errorList People
Parameters
- queries *ListPeopleQueries - Queries to be sent with the request
Return Type
- PeopleCollection|error - Collection of Person
createPeople
Create Person
Parameters
- payload Person - The request body
getPeople
function getPeople(string partyNumber, map<string|string[]> headers, *GetPeopleQueries queries) returns Person|errorGet Person by key
Parameters
- partyNumber string - The party number key field
- queries *GetPeopleQueries - Queries to be sent with the request
deletePeople
function deletePeople(string partyNumber, DeletePeopleHeaders headers) returns error?Delete Person
Parameters
- partyNumber string - The party number key field
- headers DeletePeopleHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - Person deleted
updatePeople
function updatePeople(string partyNumber, Person payload, UpdatePeopleHeaders headers) returns Person|errorUpdate Person
Parameters
- partyNumber string - The party number key field
- payload Person - The request body
- headers UpdatePeopleHeaders (default {}) - Headers to be sent with the request
listPersonImages
function listPersonImages(map<string|string[]> headers, *ListPersonImagesQueries queries) returns PersonImagesCollection|errorList PersonImages
Parameters
- queries *ListPersonImagesQueries - Queries to be sent with the request
Return Type
- PersonImagesCollection|error - Collection of PersonImage
createPersonImages
function createPersonImages(PersonImage payload, map<string|string[]> headers) returns PersonImage|errorCreate PersonImage
Parameters
- payload PersonImage - The request body
Return Type
- PersonImage|error - PersonImage created
getPersonImages
function getPersonImages(string partyNumber, map<string|string[]> headers, *GetPersonImagesQueries queries) returns PersonImage|errorGet PersonImage by key
Parameters
- partyNumber string - The party number key field
- queries *GetPersonImagesQueries - Queries to be sent with the request
Return Type
- PersonImage|error - PersonImage
deletePersonImages
function deletePersonImages(string partyNumber, DeletePersonImagesHeaders headers) returns error?Delete PersonImage
Parameters
- partyNumber string - The party number key field
- headers DeletePersonImagesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - PersonImage deleted
updatePersonImages
function updatePersonImages(string partyNumber, PersonImage payload, UpdatePersonImagesHeaders headers) returns PersonImage|errorUpdate PersonImage
Parameters
- partyNumber string - The party number key field
- payload PersonImage - The request body
- headers UpdatePersonImagesHeaders (default {}) - Headers to be sent with the request
Return Type
- PersonImage|error - PersonImage updated
listPersonUsers
function listPersonUsers(map<string|string[]> headers, *ListPersonUsersQueries queries) returns PersonUsersCollection|errorList PersonUsers
Parameters
- queries *ListPersonUsersQueries - Queries to be sent with the request
Return Type
- PersonUsersCollection|error - Collection of PersonUser
createPersonUsers
function createPersonUsers(PersonUser payload, map<string|string[]> headers) returns PersonUser|errorCreate PersonUser
Parameters
- payload PersonUser - The request body
Return Type
- PersonUser|error - PersonUser created
getPersonUsers
function getPersonUsers(string userId, string partyNumber, string validFrom, map<string|string[]> headers, *GetPersonUsersQueries queries) returns PersonUser|errorGet PersonUser by key
Parameters
- userId string - The user id key field
- partyNumber string - The party number key field
- validFrom string - The valid from key field
- queries *GetPersonUsersQueries - Queries to be sent with the request
Return Type
- PersonUser|error - PersonUser
deletePersonUsers
function deletePersonUsers(string userId, string partyNumber, string validFrom, DeletePersonUsersHeaders headers) returns error?Delete PersonUser
Parameters
- userId string - The user id key field
- partyNumber string - The party number key field
- validFrom string - The valid from key field
- headers DeletePersonUsersHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - PersonUser deleted
updatePersonUsers
function updatePersonUsers(string userId, string partyNumber, string validFrom, PersonUser payload, UpdatePersonUsersHeaders headers) returns PersonUser|errorUpdate PersonUser
Parameters
- userId string - The user id key field
- partyNumber string - The party number key field
- validFrom string - The valid from key field
- payload PersonUser - The request body
- headers UpdatePersonUsersHeaders (default {}) - Headers to be sent with the request
Return Type
- PersonUser|error - PersonUser updated
listStateHolidays
function listStateHolidays(map<string|string[]> headers, *ListStateHolidaysQueries queries) returns StateHolidaysCollection|errorList StateHolidays
Parameters
- queries *ListStateHolidaysQueries - Queries to be sent with the request
Return Type
- StateHolidaysCollection|error - Collection of StateHoliday
createStateHolidays
function createStateHolidays(StateHoliday payload, map<string|string[]> headers) returns StateHoliday|errorCreate StateHoliday
Parameters
- payload StateHoliday - The request body
Return Type
- StateHoliday|error - StateHoliday created
getStateHolidays
function getStateHolidays(string holidayDate, string countryRegionId, string stateId, map<string|string[]> headers, *GetStateHolidaysQueries queries) returns StateHoliday|errorGet StateHoliday by key
Parameters
- holidayDate string - The holiday date key field
- countryRegionId string - The country region id key field
- stateId string - The state id key field
- queries *GetStateHolidaysQueries - Queries to be sent with the request
Return Type
- StateHoliday|error - StateHoliday
deleteStateHolidays
function deleteStateHolidays(string holidayDate, string countryRegionId, string stateId, DeleteStateHolidaysHeaders headers) returns error?Delete StateHoliday
Parameters
- holidayDate string - The holiday date key field
- countryRegionId string - The country region id key field
- stateId string - The state id key field
- headers DeleteStateHolidaysHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - StateHoliday deleted
updateStateHolidays
function updateStateHolidays(string holidayDate, string countryRegionId, string stateId, StateHoliday payload, UpdateStateHolidaysHeaders headers) returns StateHoliday|errorUpdate StateHoliday
Parameters
- holidayDate string - The holiday date key field
- countryRegionId string - The country region id key field
- stateId string - The state id key field
- payload StateHoliday - The request body
- headers UpdateStateHolidaysHeaders (default {}) - Headers to be sent with the request
Return Type
- StateHoliday|error - StateHoliday updated
Records
microsoft.dynamics365.finance.hr: AbsenceCode
Fields
- description? string -
- absenceGroup? string -
- includeInReport? NoYes -
- absenceCode? string -
- continueAbsence? NoYes -
- payType? string -
- method? JmgAbsenceMethodEnum -
- offsetAccountDisplayValue? string -
- dataAreaId? string -
- column? Signed32 -
- dimensionDisplayValue? string -
- registration? NoYes -
- jobIdentification? string -
- days? decimal -
- mainAccountDisplayValue? string -
- textColor? Signed32 -
- icon? Signed32 -
- letterCode? string -
- backgroundColor? Signed32 -
microsoft.dynamics365.finance.hr: AbsenceCodesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *AbsenceCodesCollectionAllOf2
- value AbsenceCode[]
- anydata...
microsoft.dynamics365.finance.hr: AbsenceCodesCollectionAllOf2
Fields
- value? AbsenceCode[] -
microsoft.dynamics365.finance.hr: AbsenceReason
Fields
- dataAreaId? string -
- absenceCode? string -
- reasonCodeId? string -
microsoft.dynamics365.finance.hr: AbsenceReasonsCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *AbsenceReasonsCollectionAllOf2
- value AbsenceReason[]
- anydata...
microsoft.dynamics365.finance.hr: AbsenceReasonsCollectionAllOf2
Fields
- value? AbsenceReason[] -
microsoft.dynamics365.finance.hr: CityHoliday
Fields
- description? string -
- countryRegionId? string -
- holidayDate? string -
- stateId? string -
- cityName? string -
microsoft.dynamics365.finance.hr: CityHolidaysCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *CityHolidaysCollectionAllOf2
- value CityHoliday[]
- anydata...
microsoft.dynamics365.finance.hr: CityHolidaysCollectionAllOf2
Fields
- value? CityHoliday[] -
microsoft.dynamics365.finance.hr: ConnectionConfig
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-forwardedheader
- 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,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
microsoft.dynamics365.finance.hr: DeleteAbsenceCodesHeaders
Represents the Headers record for the operation: deleteAbsenceCodes
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeleteAbsenceReasonsHeaders
Represents the Headers record for the operation: deleteAbsenceReasons
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeleteCityHolidaysHeaders
Represents the Headers record for the operation: deleteCityHolidays
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeleteEmploymentsHeaders
Represents the Headers record for the operation: deleteEmployments
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeleteEssWorkersHeaders
Represents the Headers record for the operation: deleteEssWorkers
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeleteInjuryTypesHeaders
Represents the Headers record for the operation: deleteInjuryTypes
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeletePeopleHeaders
Represents the Headers record for the operation: deletePeople
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeletePersonImagesHeaders
Represents the Headers record for the operation: deletePersonImages
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeletePersonUsersHeaders
Represents the Headers record for the operation: deletePersonUsers
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: DeleteStateHolidaysHeaders
Represents the Headers record for the operation: deleteStateHolidays
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: Employment
Fields
- workerType? HcmEmploymentType -
- calendarLegalEntityId? string -
- personnelNumber? string -
- employmentEndDate? string -
- regulatoryEstablishmentId? string -
- dimensionDisplayValue? string -
- legalEntityId? string -
- calendarId? string -
- employmentStartDate? string -
microsoft.dynamics365.finance.hr: EmploymentsCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *EmploymentsCollectionAllOf2
- value Employment[]
- anydata...
microsoft.dynamics365.finance.hr: EmploymentsCollectionAllOf2
Fields
- value? Employment[] -
microsoft.dynamics365.finance.hr: EssWorker
Fields
- personnelNumber? string -
- firstName? string -
- knownAs? string -
- nameSequenceDisplayAs? string -
- professionalSuffix? string -
- middleName? string -
- name? string -
- aadUserObjectId? string -
- partyNumber? string -
- phoneticFirstName? string -
- phoneticLastName? string -
- nameAlias? string -
- userId? string -
- phoneticMiddleName? string -
- lastNamePrefix? string -
- lastName? string -
- personalTitle? string -
- aadUserPrincipalName? string -
- professionalTitle? string -
- partyType? string -
- languageId? string -
- personalSuffix? string -
microsoft.dynamics365.finance.hr: EssWorkersCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *EssWorkersCollectionAllOf2
- value EssWorker[]
- anydata...
microsoft.dynamics365.finance.hr: EssWorkersCollectionAllOf2
Fields
- value? EssWorker[] -
microsoft.dynamics365.finance.hr: GetAbsenceCodesQueries
Represents the Queries record for the operation: getAbsenceCodes
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.hr: GetAbsenceReasonsQueries
Represents the Queries record for the operation: getAbsenceReasons
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.hr: GetCityHolidaysQueries
Represents the Queries record for the operation: getCityHolidays
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.hr: GetEmploymentsQueries
Represents the Queries record for the operation: getEmployments
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.hr: GetEssWorkersQueries
Represents the Queries record for the operation: getEssWorkers
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.hr: GetInjuryTypesQueries
Represents the Queries record for the operation: getInjuryTypes
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.hr: GetPeopleQueries
Represents the Queries record for the operation: getPeople
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.hr: GetPersonImagesQueries
Represents the Queries record for the operation: getPersonImages
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.hr: GetPersonUsersQueries
Represents the Queries record for the operation: getPersonUsers
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.hr: GetStateHolidaysQueries
Represents the Queries record for the operation: getStateHolidays
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.hr: InjuryType
Fields
- description? string -
- injuryTypeId? string -
microsoft.dynamics365.finance.hr: InjuryTypesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *InjuryTypesCollectionAllOf2
- value InjuryType[]
- anydata...
microsoft.dynamics365.finance.hr: InjuryTypesCollectionAllOf2
Fields
- value? InjuryType[] -
microsoft.dynamics365.finance.hr: ListAbsenceCodesQueries
Represents the Queries record for the operation: listAbsenceCodes
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.hr: ListAbsenceReasonsQueries
Represents the Queries record for the operation: listAbsenceReasons
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.hr: ListCityHolidaysQueries
Represents the Queries record for the operation: listCityHolidays
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.hr: ListEmploymentsQueries
Represents the Queries record for the operation: listEmployments
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.hr: ListEssWorkersQueries
Represents the Queries record for the operation: listEssWorkers
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.hr: ListInjuryTypesQueries
Represents the Queries record for the operation: listInjuryTypes
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.hr: ListPeopleQueries
Represents the Queries record for the operation: listPeople
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.hr: ListPersonImagesQueries
Represents the Queries record for the operation: listPersonImages
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.hr: ListPersonUsersQueries
Represents the Queries record for the operation: listPersonUsers
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.hr: ListStateHolidaysQueries
Represents the Queries record for the operation: listStateHolidays
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.hr: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token") - Token URL
microsoft.dynamics365.finance.hr: ODataCollection
Fields
- odataNextLink? string -
- odataCount? int -
- odataContext? string -
microsoft.dynamics365.finance.hr: PeopleCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PeopleCollectionAllOf2
- value Person[]
- anydata...
microsoft.dynamics365.finance.hr: PeopleCollectionAllOf2
Fields
- value? Person[] -
microsoft.dynamics365.finance.hr: Person
Fields
- primaryContactEmailPurpose? string -
- anniversaryYear? Signed32 -
- primaryContactEmail? string -
- gender? Gender -
- primaryContactPhonePurpose? string -
- name? string -
- primaryContactPhoneDescription? string -
- addressCity? string -
- primaryContactTwitterDescription? string -
- addressLongitude? decimal -
- primaryContactTwitter? string -
- addressValidFrom? string -
- primaryContactPhoneExtension? string -
- primaryContactEmailIsIM? NoYes -
- personalSuffix? string -
- birthYear? Signed32 -
- birthMonth? MonthsOfYear -
- primaryContactFax? string -
- addressTimeZone? Timezone -
- primaryContactLinkedIn? string -
- childrenNames? string -
- addressIsPrivate? NoYes -
- professionalSuffix? string -
- initials? string -
- addressLocationId? string -
- addressCountryRegionId? string -
- primaryContactTwitterPurpose? string -
- addressCountryRegionISOCode? string -
- fullPrimaryAddress? string -
- primaryContactLinkedInPurpose? string -
- maritalStatus? DirPersonMaritalStatus -
- phoneticFirstName? string -
- nameAlias? string -
- phoneticLastName? string -
- phoneticMiddleName? string -
- addressValidTo? string -
- lastNamePrefix? string -
- primaryContactURLDescription? string -
- lastName? string -
- primaryContactFacebookDescription? string -
- addressZipCode? string -
- addressLocationRoles? string -
- addressBooks? string -
- primaryContactURL? string -
- knownAs? string -
- primaryContactFacebookPurpose? string -
- primaryContactLinkedInIsPrivate? NoYes -
- primaryContactURLPurpose? string -
- addressCounty? string -
- primaryContactEmailDescription? string -
- primaryContactLinkedInDescription? string -
- addressDescription? string -
- primaryContactTwitterIsPrivate? NoYes -
- anniversaryDay? Signed32 -
- anniversaryMonth? MonthsOfYear -
- primaryContactPhoneIsMobile? NoYes -
- partyType? string -
- primaryContactPhone? string -
- primaryContactTelexDescription? string -
- primaryContactFaxExtension? string -
- primaryContactTelexPurpose? string -
- primaryContactFacebook? string -
- electronicLocationId? string -
- firstName? string -
- primaryContactFacebookIsPrivate? NoYes -
- birthDay? Signed32 -
- nameSequenceDisplayAs? string -
- addressDistrictName? string -
- middleName? string -
- hobbies? string -
- partyNumber? string -
- primaryContactFaxPurpose? string -
- primaryContactFaxDescription? string -
- primaryContactTelex? string -
- addressStreet? string -
- personalTitle? string -
- professionalTitle? string -
- languageId? string -
- addressState? string -
- addressLatitude? decimal -
microsoft.dynamics365.finance.hr: PersonImage
Fields
- partyNumber? string -
- image? record { fileContent byte[], fileName string } -
microsoft.dynamics365.finance.hr: PersonImagesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PersonImagesCollectionAllOf2
- value PersonImage[]
- anydata...
microsoft.dynamics365.finance.hr: PersonImagesCollectionAllOf2
Fields
- value? PersonImage[] -
microsoft.dynamics365.finance.hr: PersonUser
Fields
- partyNumber? string -
- personName? string -
- personNameAlias? string -
- userId? string -
- validTo? string -
- personPrimaryEmail? string -
- validFrom? string -
- userEmail? string -
microsoft.dynamics365.finance.hr: PersonUsersCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PersonUsersCollectionAllOf2
- value PersonUser[]
- anydata...
microsoft.dynamics365.finance.hr: PersonUsersCollectionAllOf2
Fields
- value? PersonUser[] -
microsoft.dynamics365.finance.hr: StateHoliday
Fields
- description? string -
- holidayDate? string -
- countryRegionId? string -
- stateId? string -
microsoft.dynamics365.finance.hr: StateHolidaysCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *StateHolidaysCollectionAllOf2
- value StateHoliday[]
- anydata...
microsoft.dynamics365.finance.hr: StateHolidaysCollectionAllOf2
Fields
- value? StateHoliday[] -
microsoft.dynamics365.finance.hr: UpdateAbsenceCodesHeaders
Represents the Headers record for the operation: updateAbsenceCodes
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdateAbsenceReasonsHeaders
Represents the Headers record for the operation: updateAbsenceReasons
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdateCityHolidaysHeaders
Represents the Headers record for the operation: updateCityHolidays
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdateEmploymentsHeaders
Represents the Headers record for the operation: updateEmployments
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdateEssWorkersHeaders
Represents the Headers record for the operation: updateEssWorkers
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdateInjuryTypesHeaders
Represents the Headers record for the operation: updateInjuryTypes
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdatePeopleHeaders
Represents the Headers record for the operation: updatePeople
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdatePersonImagesHeaders
Represents the Headers record for the operation: updatePersonImages
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdatePersonUsersHeaders
Represents the Headers record for the operation: updatePersonUsers
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.hr: UpdateStateHolidaysHeaders
Represents the Headers record for the operation: updateStateHolidays
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
Union types
microsoft.dynamics365.finance.hr: JmgAbsenceMethodEnum
JmgAbsenceMethodEnum
microsoft.dynamics365.finance.hr: Timezone
Timezone
microsoft.dynamics365.finance.hr: HcmEmploymentType
HcmEmploymentType
microsoft.dynamics365.finance.hr: DirPersonMaritalStatus
DirPersonMaritalStatus
microsoft.dynamics365.finance.hr: NoYes
NoYes
microsoft.dynamics365.finance.hr: Gender
Gender
microsoft.dynamics365.finance.hr: MonthsOfYear
MonthsOfYear
Import
import ballerinax/microsoft.dynamics365.finance.hr;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
Keywords
Name/Microsoft Dynamics 365 Finance Human Resources
Area/Human Resources
Vendor/Microsoft
Dynamics365
Finance
ERP
Type/Connector
HR
Employee
Worker
Person
Contributors