microsoft.dynamics365.finance.payment
Module microsoft.dynamics365.finance.payment
API
Definitions
ballerinax/microsoft.dynamics365.finance.payment 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.payment connector provides access to Microsoft Dynamics 365 Finance Payment entities via the OData REST API.
Key Features
- Manage payment 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.payment connector in your Ballerina application, modify the .bal file as follows:
Step 1: Import the module
import ballerinax/microsoft.dynamics365.finance.payment;
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" payment: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
payment:CurrenciesCollection results = check cl->listCurrencies();
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.payment: 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
listCurrencies
function listCurrencies(map<string|string[]> headers, *ListCurrenciesQueries queries) returns CurrenciesCollection|errorList Currencies
Parameters
- queries *ListCurrenciesQueries - Queries to be sent with the request
Return Type
- CurrenciesCollection|error - Collection of Currency
createCurrencies
Create Currency
Parameters
- payload Currency - The request body
getCurrencies
function getCurrencies(string currencyCode, map<string|string[]> headers, *GetCurrenciesQueries queries) returns Currency|errorGet Currency by key
Parameters
- currencyCode string - The currency code key field
- queries *GetCurrenciesQueries - Queries to be sent with the request
deleteCurrencies
function deleteCurrencies(string currencyCode, DeleteCurrenciesHeaders headers) returns error?Delete Currency
Parameters
- currencyCode string - The currency code key field
- headers DeleteCurrenciesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - Currency deleted
updateCurrencies
function updateCurrencies(string currencyCode, Currency payload, UpdateCurrenciesHeaders headers) returns Currency|errorUpdate Currency
Parameters
- currencyCode string - The currency code key field
- payload Currency - The request body
- headers UpdateCurrenciesHeaders (default {}) - Headers to be sent with the request
listCurrencyRules
function listCurrencyRules(map<string|string[]> headers, *ListCurrencyRulesQueries queries) returns CurrencyRulesCollection|errorList CurrencyRules
Parameters
- queries *ListCurrencyRulesQueries - Queries to be sent with the request
Return Type
- CurrencyRulesCollection|error - Collection of CurrencyRule
createCurrencyRules
function createCurrencyRules(CurrencyRule payload, map<string|string[]> headers) returns CurrencyRule|errorCreate CurrencyRule
Parameters
- payload CurrencyRule - The request body
Return Type
- CurrencyRule|error - CurrencyRule created
getCurrencyRules
function getCurrencyRules(string dataAreaId, string ruleGroup, string currencyRuleGroup, string currency, map<string|string[]> headers, *GetCurrencyRulesQueries queries) returns CurrencyRule|errorGet CurrencyRule by key
Parameters
- dataAreaId string - The company data area identifier
- ruleGroup string - The rule group key field
- currencyRuleGroup string - The currency rule group key field
- currency string - The currency key field
- queries *GetCurrencyRulesQueries - Queries to be sent with the request
Return Type
- CurrencyRule|error - CurrencyRule
deleteCurrencyRules
function deleteCurrencyRules(string dataAreaId, string ruleGroup, string currencyRuleGroup, string currency, DeleteCurrencyRulesHeaders headers) returns error?Delete CurrencyRule
Parameters
- dataAreaId string - The company data area identifier
- ruleGroup string - The rule group key field
- currencyRuleGroup string - The currency rule group key field
- currency string - The currency key field
- headers DeleteCurrencyRulesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - CurrencyRule deleted
updateCurrencyRules
function updateCurrencyRules(string dataAreaId, string ruleGroup, string currencyRuleGroup, string currency, CurrencyRule payload, UpdateCurrencyRulesHeaders headers) returns CurrencyRule|errorUpdate CurrencyRule
Parameters
- dataAreaId string - The company data area identifier
- ruleGroup string - The rule group key field
- currencyRuleGroup string - The currency rule group key field
- currency string - The currency key field
- payload CurrencyRule - The request body
- headers UpdateCurrencyRulesHeaders (default {}) - Headers to be sent with the request
Return Type
- CurrencyRule|error - CurrencyRule updated
listDenominations
function listDenominations(map<string|string[]> headers, *ListDenominationsQueries queries) returns DenominationsCollection|errorList Denominations
Parameters
- queries *ListDenominationsQueries - Queries to be sent with the request
Return Type
- DenominationsCollection|error - Collection of Denomination
createDenominations
function createDenominations(Denomination payload, map<string|string[]> headers) returns Denomination|errorCreate Denomination
Parameters
- payload Denomination - The request body
Return Type
- Denomination|error - Denomination created
getDenominations
function getDenominations(string dataAreaId, string name, map<string|string[]> headers, *GetDenominationsQueries queries) returns Denomination|errorGet Denomination by key
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- queries *GetDenominationsQueries - Queries to be sent with the request
Return Type
- Denomination|error - Denomination
deleteDenominations
function deleteDenominations(string dataAreaId, string name, DeleteDenominationsHeaders headers) returns error?Delete Denomination
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- headers DeleteDenominationsHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - Denomination deleted
updateDenominations
function updateDenominations(string dataAreaId, string name, Denomination payload, UpdateDenominationsHeaders headers) returns Denomination|errorUpdate Denomination
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- payload Denomination - The request body
- headers UpdateDenominationsHeaders (default {}) - Headers to be sent with the request
Return Type
- Denomination|error - Denomination updated
listExchangeRates
function listExchangeRates(map<string|string[]> headers, *ListExchangeRatesQueries queries) returns ExchangeRatesCollection|errorList ExchangeRates
Parameters
- queries *ListExchangeRatesQueries - Queries to be sent with the request
Return Type
- ExchangeRatesCollection|error - Collection of ExchangeRate
createExchangeRates
function createExchangeRates(ExchangeRate payload, map<string|string[]> headers) returns ExchangeRate|errorCreate ExchangeRate
Parameters
- payload ExchangeRate - The request body
Return Type
- ExchangeRate|error - ExchangeRate created
getExchangeRates
function getExchangeRates(string rateTypeName, string fromCurrency, string toCurrency, string startDate, map<string|string[]> headers, *GetExchangeRatesQueries queries) returns ExchangeRate|errorGet ExchangeRate by key
Parameters
- rateTypeName string - The rate type name key field
- fromCurrency string - The from currency key field
- toCurrency string - The to currency key field
- startDate string - The start date key field
- queries *GetExchangeRatesQueries - Queries to be sent with the request
Return Type
- ExchangeRate|error - ExchangeRate
deleteExchangeRates
function deleteExchangeRates(string rateTypeName, string fromCurrency, string toCurrency, string startDate, DeleteExchangeRatesHeaders headers) returns error?Delete ExchangeRate
Parameters
- rateTypeName string - The rate type name key field
- fromCurrency string - The from currency key field
- toCurrency string - The to currency key field
- startDate string - The start date key field
- headers DeleteExchangeRatesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - ExchangeRate deleted
updateExchangeRates
function updateExchangeRates(string rateTypeName, string fromCurrency, string toCurrency, string startDate, ExchangeRate payload, UpdateExchangeRatesHeaders headers) returns ExchangeRate|errorUpdate ExchangeRate
Parameters
- rateTypeName string - The rate type name key field
- fromCurrency string - The from currency key field
- toCurrency string - The to currency key field
- startDate string - The start date key field
- payload ExchangeRate - The request body
- headers UpdateExchangeRatesHeaders (default {}) - Headers to be sent with the request
Return Type
- ExchangeRate|error - ExchangeRate updated
listExchangeRatesNonISO
function listExchangeRatesNonISO(map<string|string[]> headers, *ListExchangeRatesNonISOQueries queries) returns ExchangeRatesNonISOCollection|errorList ExchangeRatesNonISO
Parameters
- queries *ListExchangeRatesNonISOQueries - Queries to be sent with the request
Return Type
- ExchangeRatesNonISOCollection|error - Collection of ExchangeRateNonISO
createExchangeRatesNonISO
function createExchangeRatesNonISO(ExchangeRateNonISO payload, map<string|string[]> headers) returns ExchangeRateNonISO|errorCreate ExchangeRateNonISO
Parameters
- payload ExchangeRateNonISO - The request body
Return Type
- ExchangeRateNonISO|error - ExchangeRateNonISO created
getExchangeRatesNonISO
function getExchangeRatesNonISO(string rateTypeName, string fromCurrency, string toCurrency, string startDate, map<string|string[]> headers, *GetExchangeRatesNonISOQueries queries) returns ExchangeRateNonISO|errorGet ExchangeRateNonISO by key
Parameters
- rateTypeName string - The rate type name key field
- fromCurrency string - The from currency key field
- toCurrency string - The to currency key field
- startDate string - The start date key field
- queries *GetExchangeRatesNonISOQueries - Queries to be sent with the request
Return Type
- ExchangeRateNonISO|error - ExchangeRateNonISO
deleteExchangeRatesNonISO
function deleteExchangeRatesNonISO(string rateTypeName, string fromCurrency, string toCurrency, string startDate, DeleteExchangeRatesNonISOHeaders headers) returns error?Delete ExchangeRateNonISO
Parameters
- rateTypeName string - The rate type name key field
- fromCurrency string - The from currency key field
- toCurrency string - The to currency key field
- startDate string - The start date key field
- headers DeleteExchangeRatesNonISOHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - ExchangeRateNonISO deleted
updateExchangeRatesNonISO
function updateExchangeRatesNonISO(string rateTypeName, string fromCurrency, string toCurrency, string startDate, ExchangeRateNonISO payload, UpdateExchangeRatesNonISOHeaders headers) returns ExchangeRateNonISO|errorUpdate ExchangeRateNonISO
Parameters
- rateTypeName string - The rate type name key field
- fromCurrency string - The from currency key field
- toCurrency string - The to currency key field
- startDate string - The start date key field
- payload ExchangeRateNonISO - The request body
- headers UpdateExchangeRatesNonISOHeaders (default {}) - Headers to be sent with the request
Return Type
- ExchangeRateNonISO|error - ExchangeRateNonISO updated
listPaymentCalendarRules
function listPaymentCalendarRules(map<string|string[]> headers, *ListPaymentCalendarRulesQueries queries) returns PaymentCalendarRulesCollection|errorList PaymentCalendarRules
Parameters
- queries *ListPaymentCalendarRulesQueries - Queries to be sent with the request
Return Type
- PaymentCalendarRulesCollection|error - Collection of PaymentCalendarRule
createPaymentCalendarRules
function createPaymentCalendarRules(PaymentCalendarRule payload, map<string|string[]> headers) returns PaymentCalendarRule|errorCreate PaymentCalendarRule
Parameters
- payload PaymentCalendarRule - The request body
Return Type
- PaymentCalendarRule|error - PaymentCalendarRule created
getPaymentCalendarRules
function getPaymentCalendarRules(string dataAreaId, string moduleType, int priority, map<string|string[]> headers, *GetPaymentCalendarRulesQueries queries) returns PaymentCalendarRule|errorGet PaymentCalendarRule by key
Parameters
- dataAreaId string - The company data area identifier
- moduleType string - The module type key field
- priority int - The priority key field
- queries *GetPaymentCalendarRulesQueries - Queries to be sent with the request
Return Type
- PaymentCalendarRule|error - PaymentCalendarRule
deletePaymentCalendarRules
function deletePaymentCalendarRules(string dataAreaId, string moduleType, int priority, DeletePaymentCalendarRulesHeaders headers) returns error?Delete PaymentCalendarRule
Parameters
- dataAreaId string - The company data area identifier
- moduleType string - The module type key field
- priority int - The priority key field
- headers DeletePaymentCalendarRulesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - PaymentCalendarRule deleted
updatePaymentCalendarRules
function updatePaymentCalendarRules(string dataAreaId, string moduleType, int priority, PaymentCalendarRule payload, UpdatePaymentCalendarRulesHeaders headers) returns PaymentCalendarRule|errorUpdate PaymentCalendarRule
Parameters
- dataAreaId string - The company data area identifier
- moduleType string - The module type key field
- priority int - The priority key field
- payload PaymentCalendarRule - The request body
- headers UpdatePaymentCalendarRulesHeaders (default {}) - Headers to be sent with the request
Return Type
- PaymentCalendarRule|error - PaymentCalendarRule updated
listPaymentDays
function listPaymentDays(map<string|string[]> headers, *ListPaymentDaysQueries queries) returns PaymentDaysCollection|errorList PaymentDays
Parameters
- queries *ListPaymentDaysQueries - Queries to be sent with the request
Return Type
- PaymentDaysCollection|error - Collection of PaymentDay
createPaymentDays
function createPaymentDays(PaymentDay payload, map<string|string[]> headers) returns PaymentDay|errorCreate PaymentDay
Parameters
- payload PaymentDay - The request body
Return Type
- PaymentDay|error - PaymentDay created
getPaymentDays
function getPaymentDays(string dataAreaId, string name, string frequency, string dayOfWeek, int dayOfMonth, map<string|string[]> headers, *GetPaymentDaysQueries queries) returns PaymentDay|errorGet PaymentDay by key
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- frequency string - The frequency key field
- dayOfWeek string - The day of week key field
- dayOfMonth int - The day of month key field
- queries *GetPaymentDaysQueries - Queries to be sent with the request
Return Type
- PaymentDay|error - PaymentDay
deletePaymentDays
function deletePaymentDays(string dataAreaId, string name, string frequency, string dayOfWeek, int dayOfMonth, DeletePaymentDaysHeaders headers) returns error?Delete PaymentDay
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- frequency string - The frequency key field
- dayOfWeek string - The day of week key field
- dayOfMonth int - The day of month key field
- headers DeletePaymentDaysHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - PaymentDay deleted
updatePaymentDays
function updatePaymentDays(string dataAreaId, string name, string frequency, string dayOfWeek, int dayOfMonth, PaymentDay payload, UpdatePaymentDaysHeaders headers) returns PaymentDay|errorUpdate PaymentDay
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- frequency string - The frequency key field
- dayOfWeek string - The day of week key field
- dayOfMonth int - The day of month key field
- payload PaymentDay - The request body
- headers UpdatePaymentDaysHeaders (default {}) - Headers to be sent with the request
Return Type
- PaymentDay|error - PaymentDay updated
listPaymentInstructions
function listPaymentInstructions(map<string|string[]> headers, *ListPaymentInstructionsQueries queries) returns PaymentInstructionsCollection|errorList PaymentInstructions
Parameters
- queries *ListPaymentInstructionsQueries - Queries to be sent with the request
Return Type
- PaymentInstructionsCollection|error - Collection of PaymentInstruction
createPaymentInstructions
function createPaymentInstructions(PaymentInstruction payload, map<string|string[]> headers) returns PaymentInstruction|errorCreate PaymentInstruction
Parameters
- payload PaymentInstruction - The request body
Return Type
- PaymentInstruction|error - PaymentInstruction created
getPaymentInstructions
function getPaymentInstructions(string dataAreaId, string paymentInstructionCode, map<string|string[]> headers, *GetPaymentInstructionsQueries queries) returns PaymentInstruction|errorGet PaymentInstruction by key
Parameters
- dataAreaId string - The company data area identifier
- paymentInstructionCode string - The payment instruction code key field
- queries *GetPaymentInstructionsQueries - Queries to be sent with the request
Return Type
- PaymentInstruction|error - PaymentInstruction
deletePaymentInstructions
function deletePaymentInstructions(string dataAreaId, string paymentInstructionCode, DeletePaymentInstructionsHeaders headers) returns error?Delete PaymentInstruction
Parameters
- dataAreaId string - The company data area identifier
- paymentInstructionCode string - The payment instruction code key field
- headers DeletePaymentInstructionsHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - PaymentInstruction deleted
updatePaymentInstructions
function updatePaymentInstructions(string dataAreaId, string paymentInstructionCode, PaymentInstruction payload, UpdatePaymentInstructionsHeaders headers) returns PaymentInstruction|errorUpdate PaymentInstruction
Parameters
- dataAreaId string - The company data area identifier
- paymentInstructionCode string - The payment instruction code key field
- payload PaymentInstruction - The request body
- headers UpdatePaymentInstructionsHeaders (default {}) - Headers to be sent with the request
Return Type
- PaymentInstruction|error - PaymentInstruction updated
listPaymentMethods
function listPaymentMethods(map<string|string[]> headers, *ListPaymentMethodsQueries queries) returns PaymentMethodsCollection|errorList PaymentMethods
Parameters
- queries *ListPaymentMethodsQueries - Queries to be sent with the request
Return Type
- PaymentMethodsCollection|error - Collection of PaymentMethod
createPaymentMethods
function createPaymentMethods(PaymentMethod payload, map<string|string[]> headers) returns PaymentMethod|errorCreate PaymentMethod
Parameters
- payload PaymentMethod - The request body
Return Type
- PaymentMethod|error - PaymentMethod created
getPaymentMethods
function getPaymentMethods(string dataAreaId, string payMethod, map<string|string[]> headers, *GetPaymentMethodsQueries queries) returns PaymentMethod|errorGet PaymentMethod by key
Parameters
- dataAreaId string - The company data area identifier
- payMethod string - The pay method key field
- queries *GetPaymentMethodsQueries - Queries to be sent with the request
Return Type
- PaymentMethod|error - PaymentMethod
deletePaymentMethods
function deletePaymentMethods(string dataAreaId, string payMethod, DeletePaymentMethodsHeaders headers) returns error?Delete PaymentMethod
Parameters
- dataAreaId string - The company data area identifier
- payMethod string - The pay method key field
- headers DeletePaymentMethodsHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - PaymentMethod deleted
updatePaymentMethods
function updatePaymentMethods(string dataAreaId, string payMethod, PaymentMethod payload, UpdatePaymentMethodsHeaders headers) returns PaymentMethod|errorUpdate PaymentMethod
Parameters
- dataAreaId string - The company data area identifier
- payMethod string - The pay method key field
- payload PaymentMethod - The request body
- headers UpdatePaymentMethodsHeaders (default {}) - Headers to be sent with the request
Return Type
- PaymentMethod|error - PaymentMethod updated
listPaymentTerms
function listPaymentTerms(map<string|string[]> headers, *ListPaymentTermsQueries queries) returns PaymentTermsCollection|errorList PaymentTerms
Parameters
- queries *ListPaymentTermsQueries - Queries to be sent with the request
Return Type
- PaymentTermsCollection|error - Collection of PaymentTerm
createPaymentTerms
function createPaymentTerms(PaymentTerm payload, map<string|string[]> headers) returns PaymentTerm|errorCreate PaymentTerm
Parameters
- payload PaymentTerm - The request body
Return Type
- PaymentTerm|error - PaymentTerm created
getPaymentTerms
function getPaymentTerms(string dataAreaId, string name, map<string|string[]> headers, *GetPaymentTermsQueries queries) returns PaymentTerm|errorGet PaymentTerm by key
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- queries *GetPaymentTermsQueries - Queries to be sent with the request
Return Type
- PaymentTerm|error - PaymentTerm
deletePaymentTerms
function deletePaymentTerms(string dataAreaId, string name, DeletePaymentTermsHeaders headers) returns error?Delete PaymentTerm
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- headers DeletePaymentTermsHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - PaymentTerm deleted
updatePaymentTerms
function updatePaymentTerms(string dataAreaId, string name, PaymentTerm payload, UpdatePaymentTermsHeaders headers) returns PaymentTerm|errorUpdate PaymentTerm
Parameters
- dataAreaId string - The company data area identifier
- name string - The name key field
- payload PaymentTerm - The request body
- headers UpdatePaymentTermsHeaders (default {}) - Headers to be sent with the request
Return Type
- PaymentTerm|error - PaymentTerm updated
listVRMCurrencies
function listVRMCurrencies(map<string|string[]> headers, *ListVRMCurrenciesQueries queries) returns VRMCurrenciesCollection|errorList VRMCurrencies
Parameters
- queries *ListVRMCurrenciesQueries - Queries to be sent with the request
Return Type
- VRMCurrenciesCollection|error - Collection of VRMCurrency
createVRMCurrencies
function createVRMCurrencies(VRMCurrency payload, map<string|string[]> headers) returns VRMCurrency|errorCreate VRMCurrency
Parameters
- payload VRMCurrency - The request body
Return Type
- VRMCurrency|error - VRMCurrency created
getVRMCurrencies
function getVRMCurrencies(string currencyCode, map<string|string[]> headers, *GetVRMCurrenciesQueries queries) returns VRMCurrency|errorGet VRMCurrency by key
Parameters
- currencyCode string - The currency code key field
- queries *GetVRMCurrenciesQueries - Queries to be sent with the request
Return Type
- VRMCurrency|error - VRMCurrency
deleteVRMCurrencies
function deleteVRMCurrencies(string currencyCode, DeleteVRMCurrenciesHeaders headers) returns error?Delete VRMCurrency
Parameters
- currencyCode string - The currency code key field
- headers DeleteVRMCurrenciesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - VRMCurrency deleted
updateVRMCurrencies
function updateVRMCurrencies(string currencyCode, VRMCurrency payload, UpdateVRMCurrenciesHeaders headers) returns VRMCurrency|errorUpdate VRMCurrency
Parameters
- currencyCode string - The currency code key field
- payload VRMCurrency - The request body
- headers UpdateVRMCurrenciesHeaders (default {}) - Headers to be sent with the request
Return Type
- VRMCurrency|error - VRMCurrency updated
listVRMLanguages
function listVRMLanguages(map<string|string[]> headers, *ListVRMLanguagesQueries queries) returns VRMLanguagesCollection|errorList VRMLanguages
Parameters
- queries *ListVRMLanguagesQueries - Queries to be sent with the request
Return Type
- VRMLanguagesCollection|error - Collection of VRMLanguage
createVRMLanguages
function createVRMLanguages(VRMLanguage payload, map<string|string[]> headers) returns VRMLanguage|errorCreate VRMLanguage
Parameters
- payload VRMLanguage - The request body
Return Type
- VRMLanguage|error - VRMLanguage created
getVRMLanguages
function getVRMLanguages(string languageId, map<string|string[]> headers, *GetVRMLanguagesQueries queries) returns VRMLanguage|errorGet VRMLanguage by key
Parameters
- languageId string - The language id key field
- queries *GetVRMLanguagesQueries - Queries to be sent with the request
Return Type
- VRMLanguage|error - VRMLanguage
deleteVRMLanguages
function deleteVRMLanguages(string languageId, DeleteVRMLanguagesHeaders headers) returns error?Delete VRMLanguage
Parameters
- languageId string - The language id key field
- headers DeleteVRMLanguagesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - VRMLanguage deleted
updateVRMLanguages
function updateVRMLanguages(string languageId, VRMLanguage payload, UpdateVRMLanguagesHeaders headers) returns VRMLanguage|errorUpdate VRMLanguage
Parameters
- languageId string - The language id key field
- payload VRMLanguage - The request body
- headers UpdateVRMLanguagesHeaders (default {}) - Headers to be sent with the request
Return Type
- VRMLanguage|error - VRMLanguage updated
listVRMParameters
function listVRMParameters(map<string|string[]> headers, *ListVRMParametersQueries queries) returns VRMParametersCollection|errorList VRMParameters
Parameters
- queries *ListVRMParametersQueries - Queries to be sent with the request
Return Type
- VRMParametersCollection|error - Collection of VRMParameter
createVRMParameters
function createVRMParameters(VRMParameter payload, map<string|string[]> headers) returns VRMParameter|errorCreate VRMParameter
Parameters
- payload VRMParameter - The request body
Return Type
- VRMParameter|error - VRMParameter created
getVRMParameters
function getVRMParameters(string dataAreaId, int 'key, map<string|string[]> headers, *GetVRMParametersQueries queries) returns VRMParameter|errorGet VRMParameter by key
Parameters
- dataAreaId string - The company data area identifier
- 'key int - The entity key value
- queries *GetVRMParametersQueries - Queries to be sent with the request
Return Type
- VRMParameter|error - VRMParameter
deleteVRMParameters
function deleteVRMParameters(string dataAreaId, int 'key, DeleteVRMParametersHeaders headers) returns error?Delete VRMParameter
Parameters
- dataAreaId string - The company data area identifier
- 'key int - The entity key value
- headers DeleteVRMParametersHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - VRMParameter deleted
updateVRMParameters
function updateVRMParameters(string dataAreaId, int 'key, VRMParameter payload, UpdateVRMParametersHeaders headers) returns VRMParameter|errorUpdate VRMParameter
Parameters
- dataAreaId string - The company data area identifier
- 'key int - The entity key value
- payload VRMParameter - The request body
- headers UpdateVRMParametersHeaders (default {}) - Headers to be sent with the request
Return Type
- VRMParameter|error - VRMParameter updated
listVRMPeople
function listVRMPeople(map<string|string[]> headers, *ListVRMPeopleQueries queries) returns VRMPeopleCollection|errorList VRMPeople
Parameters
- queries *ListVRMPeopleQueries - Queries to be sent with the request
Return Type
- VRMPeopleCollection|error - Collection of VRMPerson
createVRMPeople
Create VRMPerson
Parameters
- payload VRMPerson - The request body
getVRMPeople
function getVRMPeople(string partyNumber, map<string|string[]> headers, *GetVRMPeopleQueries queries) returns VRMPerson|errorGet VRMPerson by key
Parameters
- partyNumber string - The party number key field
- queries *GetVRMPeopleQueries - Queries to be sent with the request
deleteVRMPeople
function deleteVRMPeople(string partyNumber, DeleteVRMPeopleHeaders headers) returns error?Delete VRMPerson
Parameters
- partyNumber string - The party number key field
- headers DeleteVRMPeopleHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - VRMPerson deleted
updateVRMPeople
function updateVRMPeople(string partyNumber, VRMPerson payload, UpdateVRMPeopleHeaders headers) returns VRMPerson|errorUpdate VRMPerson
Parameters
- partyNumber string - The party number key field
- payload VRMPerson - The request body
- headers UpdateVRMPeopleHeaders (default {}) - Headers to be sent with the request
listVRMTaxGroups
function listVRMTaxGroups(map<string|string[]> headers, *ListVRMTaxGroupsQueries queries) returns VRMTaxGroupsCollection|errorList VRMTaxGroups
Parameters
- queries *ListVRMTaxGroupsQueries - Queries to be sent with the request
Return Type
- VRMTaxGroupsCollection|error - Collection of VRMTaxGroup
createVRMTaxGroups
function createVRMTaxGroups(VRMTaxGroup payload, map<string|string[]> headers) returns VRMTaxGroup|errorCreate VRMTaxGroup
Parameters
- payload VRMTaxGroup - The request body
Return Type
- VRMTaxGroup|error - VRMTaxGroup created
getVRMTaxGroups
function getVRMTaxGroups(string dataAreaId, string taxGroupCode, map<string|string[]> headers, *GetVRMTaxGroupsQueries queries) returns VRMTaxGroup|errorGet VRMTaxGroup by key
Parameters
- dataAreaId string - The company data area identifier
- taxGroupCode string - The tax group code key field
- queries *GetVRMTaxGroupsQueries - Queries to be sent with the request
Return Type
- VRMTaxGroup|error - VRMTaxGroup
deleteVRMTaxGroups
function deleteVRMTaxGroups(string dataAreaId, string taxGroupCode, DeleteVRMTaxGroupsHeaders headers) returns error?Delete VRMTaxGroup
Parameters
- dataAreaId string - The company data area identifier
- taxGroupCode string - The tax group code key field
- headers DeleteVRMTaxGroupsHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - VRMTaxGroup deleted
updateVRMTaxGroups
function updateVRMTaxGroups(string dataAreaId, string taxGroupCode, VRMTaxGroup payload, UpdateVRMTaxGroupsHeaders headers) returns VRMTaxGroup|errorUpdate VRMTaxGroup
Parameters
- dataAreaId string - The company data area identifier
- taxGroupCode string - The tax group code key field
- payload VRMTaxGroup - The request body
- headers UpdateVRMTaxGroupsHeaders (default {}) - Headers to be sent with the request
Return Type
- VRMTaxGroup|error - VRMTaxGroup updated
listVoucherTypes
function listVoucherTypes(map<string|string[]> headers, *ListVoucherTypesQueries queries) returns VoucherTypesCollection|errorList VoucherTypes
Parameters
- queries *ListVoucherTypesQueries - Queries to be sent with the request
Return Type
- VoucherTypesCollection|error - Collection of VoucherType
createVoucherTypes
function createVoucherTypes(VoucherType payload, map<string|string[]> headers) returns VoucherType|errorCreate VoucherType
Parameters
- payload VoucherType - The request body
Return Type
- VoucherType|error - VoucherType created
getVoucherTypes
function getVoucherTypes(string dataAreaId, string voucherType, map<string|string[]> headers, *GetVoucherTypesQueries queries) returns VoucherType|errorGet VoucherType by key
Parameters
- dataAreaId string - The company data area identifier
- voucherType string - The voucher type key field
- queries *GetVoucherTypesQueries - Queries to be sent with the request
Return Type
- VoucherType|error - VoucherType
deleteVoucherTypes
function deleteVoucherTypes(string dataAreaId, string voucherType, DeleteVoucherTypesHeaders headers) returns error?Delete VoucherType
Parameters
- dataAreaId string - The company data area identifier
- voucherType string - The voucher type key field
- headers DeleteVoucherTypesHeaders (default {}) - Headers to be sent with the request
Return Type
- error? - VoucherType deleted
updateVoucherTypes
function updateVoucherTypes(string dataAreaId, string voucherType, VoucherType payload, UpdateVoucherTypesHeaders headers) returns VoucherType|errorUpdate VoucherType
Parameters
- dataAreaId string - The company data area identifier
- voucherType string - The voucher type key field
- payload VoucherType - The request body
- headers UpdateVoucherTypesHeaders (default {}) - Headers to be sent with the request
Return Type
- VoucherType|error - VoucherType updated
Records
microsoft.dynamics365.finance.payment: 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.payment: AddressState
Fields
- brazilStateCode? string -
- timeZone? Timezone -
- defaultStateForCountryRegion? NoYes -
- countryRegionId? string -
- state? string -
- intrastatCode? string -
- name? string -
microsoft.dynamics365.finance.payment: Company
Fields
- partyNumber? string -
- dataArea? string -
- knownAs? string -
- languageId? string -
- name? string -
microsoft.dynamics365.finance.payment: 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.payment: CurrenciesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *CurrenciesCollectionAllOf2
- value Currency[]
- anydata...
microsoft.dynamics365.finance.payment: CurrenciesCollectionAllOf2
Fields
- value? Currency[] -
microsoft.dynamics365.finance.payment: Currency
Fields
- currencyGender? GenderMaleFemale -
- roundingRuleSalesOrders? decimal -
- roundingMethodPurchaseOrders? RoundOffType -
- symbol? string -
- roundingRuleFixedAssetDepreciation? decimal -
- roundingRulePurchaseOrders? decimal -
- generalRoundingRule? decimal -
- roundingMethodFixedAssetDepreciation? RoundOffType -
- name? string -
- currencyCode? string -
- roundingMethodSalesOrders? RoundOffType -
- roundingRulePrices? decimal -
- referenceCurrencyForTriangulation? NoYes -
- roundingMethodPrices? RoundOffType -
- decimalsCountMX? Signed32 -
microsoft.dynamics365.finance.payment: CurrencyRule
Fields
- dataAreaId? string -
- mSTAction? RTSLCurrencyAction -
- currencyIndexId? string -
- currencyRuleGroup? string -
- currency? string -
- mSTIndexId? string -
- currencyAction? RTSLCurrencyAction -
- secondaryIndexId? string -
- rateMethod? RTSLCurrencyRate -
- ruleGroup? string -
- secondaryAction? RTSLCurrencyAction -
microsoft.dynamics365.finance.payment: CurrencyRulesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *CurrencyRulesCollectionAllOf2
- value CurrencyRule[]
- anydata...
microsoft.dynamics365.finance.payment: CurrencyRulesCollectionAllOf2
Fields
- value? CurrencyRule[] -
microsoft.dynamics365.finance.payment: DeleteCurrenciesHeaders
Represents the Headers record for the operation: deleteCurrencies
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteCurrencyRulesHeaders
Represents the Headers record for the operation: deleteCurrencyRules
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteDenominationsHeaders
Represents the Headers record for the operation: deleteDenominations
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteExchangeRatesHeaders
Represents the Headers record for the operation: deleteExchangeRates
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteExchangeRatesNonISOHeaders
Represents the Headers record for the operation: deleteExchangeRatesNonISO
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeletePaymentCalendarRulesHeaders
Represents the Headers record for the operation: deletePaymentCalendarRules
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeletePaymentDaysHeaders
Represents the Headers record for the operation: deletePaymentDays
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeletePaymentInstructionsHeaders
Represents the Headers record for the operation: deletePaymentInstructions
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeletePaymentMethodsHeaders
Represents the Headers record for the operation: deletePaymentMethods
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeletePaymentTermsHeaders
Represents the Headers record for the operation: deletePaymentTerms
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteVoucherTypesHeaders
Represents the Headers record for the operation: deleteVoucherTypes
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteVRMCurrenciesHeaders
Represents the Headers record for the operation: deleteVRMCurrencies
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteVRMLanguagesHeaders
Represents the Headers record for the operation: deleteVRMLanguages
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteVRMParametersHeaders
Represents the Headers record for the operation: deleteVRMParameters
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteVRMPeopleHeaders
Represents the Headers record for the operation: deleteVRMPeople
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: DeleteVRMTaxGroupsHeaders
Represents the Headers record for the operation: deleteVRMTaxGroups
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: Denomination
Fields
- dataAreaId? string -
- currency? string -
- value? decimal -
- name? string -
- currencyName? string -
microsoft.dynamics365.finance.payment: DenominationsCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *DenominationsCollectionAllOf2
- value Denomination[]
- anydata...
microsoft.dynamics365.finance.payment: DenominationsCollectionAllOf2
Fields
- value? Denomination[] -
microsoft.dynamics365.finance.payment: ExchangeRate
Fields
- startDate? string -
- conversionFactor? ExchangeRateDisplayFactor -
- rate? decimal -
- fromCurrency? string -
- toCurrency? string -
- rateTypeName? string -
- rateTypeDescription? string -
- endDate? string -
microsoft.dynamics365.finance.payment: ExchangeRateNonISO
Fields
- startDate? string -
- conversionFactor? ExchangeRateDisplayFactor -
- rate? decimal -
- fromCurrency? string -
- toCurrency? string -
- rateTypeName? string -
- rateTypeDescription? string -
- endDate? string -
microsoft.dynamics365.finance.payment: ExchangeRatesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *ExchangeRatesCollectionAllOf2
- value ExchangeRate[]
- anydata...
microsoft.dynamics365.finance.payment: ExchangeRatesCollectionAllOf2
Fields
- value? ExchangeRate[] -
microsoft.dynamics365.finance.payment: ExchangeRatesNonISOCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *ExchangeRatesNonISOCollectionAllOf2
- value ExchangeRateNonISO[]
- anydata...
microsoft.dynamics365.finance.payment: ExchangeRatesNonISOCollectionAllOf2
Fields
- value? ExchangeRateNonISO[] -
microsoft.dynamics365.finance.payment: GetCurrenciesQueries
Represents the Queries record for the operation: getCurrencies
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.payment: GetCurrencyRulesQueries
Represents the Queries record for the operation: getCurrencyRules
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.payment: GetDenominationsQueries
Represents the Queries record for the operation: getDenominations
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.payment: GetExchangeRatesNonISOQueries
Represents the Queries record for the operation: getExchangeRatesNonISO
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.payment: GetExchangeRatesQueries
Represents the Queries record for the operation: getExchangeRates
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.payment: GetPaymentCalendarRulesQueries
Represents the Queries record for the operation: getPaymentCalendarRules
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.payment: GetPaymentDaysQueries
Represents the Queries record for the operation: getPaymentDays
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.payment: GetPaymentInstructionsQueries
Represents the Queries record for the operation: getPaymentInstructions
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.payment: GetPaymentMethodsQueries
Represents the Queries record for the operation: getPaymentMethods
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.payment: GetPaymentTermsQueries
Represents the Queries record for the operation: getPaymentTerms
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.payment: GetVoucherTypesQueries
Represents the Queries record for the operation: getVoucherTypes
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.payment: GetVRMCurrenciesQueries
Represents the Queries record for the operation: getVRMCurrencies
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.payment: GetVRMLanguagesQueries
Represents the Queries record for the operation: getVRMLanguages
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.payment: GetVRMParametersQueries
Represents the Queries record for the operation: getVRMParameters
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.payment: GetVRMPeopleQueries
Represents the Queries record for the operation: getVRMPeople
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.payment: GetVRMTaxGroupsQueries
Represents the Queries record for the operation: getVRMTaxGroups
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.payment: ListCurrenciesQueries
Represents the Queries record for the operation: listCurrencies
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.payment: ListCurrencyRulesQueries
Represents the Queries record for the operation: listCurrencyRules
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.payment: ListDenominationsQueries
Represents the Queries record for the operation: listDenominations
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.payment: ListExchangeRatesNonISOQueries
Represents the Queries record for the operation: listExchangeRatesNonISO
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.payment: ListExchangeRatesQueries
Represents the Queries record for the operation: listExchangeRates
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.payment: ListPaymentCalendarRulesQueries
Represents the Queries record for the operation: listPaymentCalendarRules
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.payment: ListPaymentDaysQueries
Represents the Queries record for the operation: listPaymentDays
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.payment: ListPaymentInstructionsQueries
Represents the Queries record for the operation: listPaymentInstructions
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.payment: ListPaymentMethodsQueries
Represents the Queries record for the operation: listPaymentMethods
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.payment: ListPaymentTermsQueries
Represents the Queries record for the operation: listPaymentTerms
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.payment: ListVoucherTypesQueries
Represents the Queries record for the operation: listVoucherTypes
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.payment: ListVRMCurrenciesQueries
Represents the Queries record for the operation: listVRMCurrencies
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.payment: ListVRMLanguagesQueries
Represents the Queries record for the operation: listVRMLanguages
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.payment: ListVRMParametersQueries
Represents the Queries record for the operation: listVRMParameters
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.payment: ListVRMPeopleQueries
Represents the Queries record for the operation: listVRMPeople
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.payment: ListVRMTaxGroupsQueries
Represents the Queries record for the operation: listVRMTaxGroups
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.payment: 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.payment: ODataCollection
Fields
- odataNextLink? string -
- odataCount? int -
- odataContext? string -
microsoft.dynamics365.finance.payment: PaymentCalendarRule
Fields
- specificCustomerPaymentMethod? string -
- thirdPartyPrimaryAddressPriority? Signed32 -
- description? string -
- specificPaymentTerms? string -
- priority? Signed32 -
- isActive? NoYes -
- thirdPartyDocumentAddressPriority? Signed32 -
- ruleType? PaymCalendarRuleType -
- specificVendorPaymentMethod? string -
- name? string -
- dataAreaId? string -
- moduleType? PaymCalendarModuleType -
- thirdPartyDocumentBankAddressPriority? Signed32 -
- specificPaymentCalendarName? string -
microsoft.dynamics365.finance.payment: PaymentCalendarRulesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PaymentCalendarRulesCollectionAllOf2
- value PaymentCalendarRule[]
- anydata...
microsoft.dynamics365.finance.payment: PaymentCalendarRulesCollectionAllOf2
Fields
- value? PaymentCalendarRule[] -
microsoft.dynamics365.finance.payment: PaymentDay
Fields
- dataAreaId? string -
- dayOfWeek? WeekDays -
- description? string -
- dayOfMonth? Signed32 -
- frequency? WeekMonth -
- name? string -
microsoft.dynamics365.finance.payment: PaymentDaysCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PaymentDaysCollectionAllOf2
- value PaymentDay[]
- anydata...
microsoft.dynamics365.finance.payment: PaymentDaysCollectionAllOf2
Fields
- value? PaymentDay[] -
microsoft.dynamics365.finance.payment: PaymentInstruction
Fields
- dataAreaId? string -
- paymentInstructionCode? string -
- description? string -
- name? string -
microsoft.dynamics365.finance.payment: PaymentInstructionsCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PaymentInstructionsCollectionAllOf2
- value PaymentInstruction[]
- anydata...
microsoft.dynamics365.finance.payment: PaymentInstructionsCollectionAllOf2
Fields
- value? PaymentInstruction[] -
microsoft.dynamics365.finance.payment: PaymentMethod
Fields
- dataAreaId? string -
- payedByTxt? string -
- postMethod? TrvPostMethod -
- automaticPayment? NoYes -
- payMethod? string -
- costOwner? TrvCostOwner -
- offsetLedgerDimensionDisplayValue? string -
microsoft.dynamics365.finance.payment: PaymentMethodsCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PaymentMethodsCollectionAllOf2
- value PaymentMethod[]
- anydata...
microsoft.dynamics365.finance.payment: PaymentMethodsCollectionAllOf2
Fields
- value? PaymentMethod[] -
microsoft.dynamics365.finance.payment: PaymentTerm
Fields
- paymentMethodType? NetCurrent -
- additionalMonthsForCutoffDate? Signed32 -
- description? string -
- creditCardCreditCheckType? CreditCardCreditCheck -
- isDefaultPaymentTerm? NoYes -
- isCertifiedCompanyCheck? NoYes -
- isCashPayment? NoYes -
- name? string -
- cutoffDayOfMonth? Signed32 -
- numberOfDays? Signed32 -
- paymentDayName? string -
- postOffsettingAR? NoYes -
- dataAreaId? string -
- customerDueDateUpdatePolicy? PaymentDueDateUpdatePolicy -
- vendorDueDateUpdatePolicy? PaymentDueDateUpdatePolicy -
- numberOfMonths? Signed32 -
- creditCardPaymentType? CreditCardPaymentType -
- paymentScheduleName? string -
- cashPaymentMainAccountIdDisplayValue? string -
microsoft.dynamics365.finance.payment: PaymentTermsCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *PaymentTermsCollectionAllOf2
- value PaymentTerm[]
- anydata...
microsoft.dynamics365.finance.payment: PaymentTermsCollectionAllOf2
Fields
- value? PaymentTerm[] -
microsoft.dynamics365.finance.payment: UpdateCurrenciesHeaders
Represents the Headers record for the operation: updateCurrencies
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateCurrencyRulesHeaders
Represents the Headers record for the operation: updateCurrencyRules
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateDenominationsHeaders
Represents the Headers record for the operation: updateDenominations
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateExchangeRatesHeaders
Represents the Headers record for the operation: updateExchangeRates
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateExchangeRatesNonISOHeaders
Represents the Headers record for the operation: updateExchangeRatesNonISO
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdatePaymentCalendarRulesHeaders
Represents the Headers record for the operation: updatePaymentCalendarRules
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdatePaymentDaysHeaders
Represents the Headers record for the operation: updatePaymentDays
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdatePaymentInstructionsHeaders
Represents the Headers record for the operation: updatePaymentInstructions
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdatePaymentMethodsHeaders
Represents the Headers record for the operation: updatePaymentMethods
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdatePaymentTermsHeaders
Represents the Headers record for the operation: updatePaymentTerms
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateVoucherTypesHeaders
Represents the Headers record for the operation: updateVoucherTypes
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateVRMCurrenciesHeaders
Represents the Headers record for the operation: updateVRMCurrencies
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateVRMLanguagesHeaders
Represents the Headers record for the operation: updateVRMLanguages
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateVRMParametersHeaders
Represents the Headers record for the operation: updateVRMParameters
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateVRMPeopleHeaders
Represents the Headers record for the operation: updateVRMPeople
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: UpdateVRMTaxGroupsHeaders
Represents the Headers record for the operation: updateVRMTaxGroups
Fields
- ifMatch? string - ETag value for optimistic concurrency; prevents overwriting concurrent modifications
microsoft.dynamics365.finance.payment: VoucherType
Fields
- dataAreaId? string -
- defaultApprovedBy? string -
- description? string -
- defaultedPreparedBy? string -
- priority? Signed32 -
- numberSequenceCode? string -
- journalName? string -
- isDefaultType? NoYes -
- voucherTypeNumber? string -
- ledgerPrintLayoutGroup? string -
- voucherType? string -
microsoft.dynamics365.finance.payment: VoucherTypesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *VoucherTypesCollectionAllOf2
- value VoucherType[]
- anydata...
microsoft.dynamics365.finance.payment: VoucherTypesCollectionAllOf2
Fields
- value? VoucherType[] -
microsoft.dynamics365.finance.payment: VRMCurrenciesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *VRMCurrenciesCollectionAllOf2
- value VRMCurrency[]
- anydata...
microsoft.dynamics365.finance.payment: VRMCurrenciesCollectionAllOf2
Fields
- value? VRMCurrency[] -
microsoft.dynamics365.finance.payment: VRMCurrency
Fields
- currencyCode? string -
- name? string -
microsoft.dynamics365.finance.payment: VRMLanguage
Fields
- description? string -
- languageId? string -
microsoft.dynamics365.finance.payment: VRMLanguagesCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *VRMLanguagesCollectionAllOf2
- value VRMLanguage[]
- anydata...
microsoft.dynamics365.finance.payment: VRMLanguagesCollectionAllOf2
Fields
- value? VRMLanguage[] -
microsoft.dynamics365.finance.payment: VRMParameter
Fields
- dataAreaId? string -
- vendorAccountNumberSequenceCode? string -
- isVendorAccountNumberSequenceManual? NoYes -
- mandatoryTaxGroup? NoYes -
- sysDataAreaId? string -
- key? Signed32 -
microsoft.dynamics365.finance.payment: VRMParametersCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *VRMParametersCollectionAllOf2
- value VRMParameter[]
- anydata...
microsoft.dynamics365.finance.payment: VRMParametersCollectionAllOf2
Fields
- value? VRMParameter[] -
microsoft.dynamics365.finance.payment: VRMPeopleCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *VRMPeopleCollectionAllOf2
- value VRMPerson[]
- anydata...
microsoft.dynamics365.finance.payment: VRMPeopleCollectionAllOf2
Fields
- value? VRMPerson[] -
microsoft.dynamics365.finance.payment: VRMPerson
Fields
- primaryContactEmailPurpose? string -
- primaryContactEmail? string -
- primaryContactPhonePurpose? string -
- name? string -
- primaryContactPhoneDescription? string -
- addressCity? string -
- primaryContactTwitterDescription? string -
- addressLongitude? decimal -
- primaryContactTwitter? string -
- addressValidFrom? string -
- primaryContactPhoneExtension? string -
- primaryContactEmailIsIM? NoYes -
- primaryContactFax? string -
- addressTimeZone? Timezone -
- primaryContactLinkedIn? string -
- addressIsPrivate? NoYes -
- addressLocationId? string -
- addressCountryRegionId? string -
- primaryContactTwitterPurpose? string -
- addressCountryRegionISOCode? string -
- fullPrimaryAddress? string -
- primaryContactLinkedInPurpose? string -
- addressValidTo? string -
- primaryContactURLDescription? string -
- lastName? string -
- primaryContactFacebookDescription? string -
- addressZipCode? string -
- addressLocationRoles? string -
- primaryContactEmailRecordId? int -
- primaryContactURL? string -
- primaryContactFacebookPurpose? string -
- primaryContactLinkedInIsPrivate? NoYes -
- globalVendorAccount? string -
- primaryContactURLPurpose? string -
- isPortalUserContext? NoYes -
- addressCounty? string -
- primaryContactEmailDescription? string -
- primaryContactLinkedInDescription? string -
- addressDescription? string -
- primaryContactTwitterIsPrivate? NoYes -
- primaryContactPhoneRecordId? int -
- primaryContactPhoneIsMobile? NoYes -
- partyType? string -
- primaryContactPhone? string -
- primaryContactTelexDescription? string -
- primaryContactFaxExtension? string -
- primaryContactTelexPurpose? string -
- primaryContactFacebook? string -
- electronicLocationId? string -
- firstName? string -
- primaryContactFacebookIsPrivate? NoYes -
- addressDistrictName? string -
- middleName? string -
- partyNumber? string -
- primaryContactFaxPurpose? string -
- primaryContactFaxDescription? string -
- primaryContactTelex? string -
- addressStreet? string -
- personalTitle? string -
- professionalTitle? string -
- languageId? string -
- addressState? string -
- addressLatitude? decimal -
microsoft.dynamics365.finance.payment: VRMTaxGroup
Fields
- dataAreaId? string -
- description? string -
- taxGroupCode? string -
microsoft.dynamics365.finance.payment: VRMTaxGroupsCollection
Fields
- Fields Included from *ODataCollection
- Fields Included from *VRMTaxGroupsCollectionAllOf2
- value VRMTaxGroup[]
- anydata...
microsoft.dynamics365.finance.payment: VRMTaxGroupsCollectionAllOf2
Fields
- value? VRMTaxGroup[] -
Union types
microsoft.dynamics365.finance.payment: RoundOffType
RoundOffType
microsoft.dynamics365.finance.payment: TrvCostOwner
TrvCostOwner
microsoft.dynamics365.finance.payment: PaymentDueDateUpdatePolicy
PaymentDueDateUpdatePolicy
microsoft.dynamics365.finance.payment: CreditCardCreditCheck
CreditCardCreditCheck
microsoft.dynamics365.finance.payment: WeekMonth
WeekMonth
microsoft.dynamics365.finance.payment: TrvPostMethod
TrvPostMethod
microsoft.dynamics365.finance.payment: WeekDays
WeekDays
microsoft.dynamics365.finance.payment: GenderMaleFemale
GenderMaleFemale
microsoft.dynamics365.finance.payment: Timezone
Timezone
microsoft.dynamics365.finance.payment: CreditCardPaymentType
CreditCardPaymentType
microsoft.dynamics365.finance.payment: PaymCalendarRuleType
PaymCalendarRuleType
microsoft.dynamics365.finance.payment: NetCurrent
NetCurrent
microsoft.dynamics365.finance.payment: PaymCalendarModuleType
PaymCalendarModuleType
microsoft.dynamics365.finance.payment: RTSLCurrencyAction
RTSLCurrencyAction
microsoft.dynamics365.finance.payment: RTSLCurrencyRate
RTSLCurrencyRate
microsoft.dynamics365.finance.payment: NoYes
NoYes
microsoft.dynamics365.finance.payment: ExchangeRateDisplayFactor
ExchangeRateDisplayFactor
Import
import ballerinax/microsoft.dynamics365.finance.payment;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 Payment
Area/Finance & Accounting
Vendor/Microsoft
Dynamics365
Finance
ERP
Type/Connector
Payment
Currency
Exchange
VRM
Contributors