Module microsoft.dynamics365.finance.tax

ballerinax/microsoft.dynamics365.finance.tax Ballerina library

0.8.0

Overview

Microsoft Dynamics 365 Finance is Microsoft's cloud ERP solution for financial management, covering general ledger, accounts receivable and payable, fixed assets, budgeting, cash and bank management, and tax.

The microsoft.dynamics365.finance.tax connector provides access to Microsoft Dynamics 365 Finance Tax entities via the OData REST API.

Key Features

Manage tax entities in Microsoft Dynamics 365 Finance
Support for list, create, read, update, and delete operations
OAuth2 client credentials authentication

Setup guide

Prerequisites

A Microsoft Dynamics 365 Finance & Operations environment (cloud-hosted or sandbox)
An Azure Active Directory (Entra ID) app registration with API permissions for Dynamics 365

Step 1: Register an application in Azure AD

Sign in to the Azure portal and navigate to Azure Active Directory → App registrations → New registration.
Give the application a name, select the appropriate account type, and click Register.
Note the Application (client) ID and Directory (tenant) ID from the overview page.
Under Certificates & secrets, create a new client secret and note the value immediately — it is only shown once.

Step 2: Grant Dynamics 365 API permissions

In the app registration, go to API permissions → Add a permission → APIs my organization uses.
Search for Dynamics 365 (or Microsoft Dynamics ERP) and add the user_impersonation (or .default) delegated/application scope.
Click Grant admin consent for your tenant.

Step 3: Add the app as a D365 user

In your D365 Finance environment, go to System administration → Users → New.
Set the User ID and User name, then paste the Azure AD Application (client) ID into the Azure AD application field.
Assign appropriate security roles and save.

Quickstart

To use the microsoft.dynamics365.finance.tax connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/microsoft.dynamics365.finance.tax;

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"

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


tax:CFOPCodesCollection results = check cl->listCFOPCodes();

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

Isolated

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://your-org.operations.dynamics.com/data" - URL of the target service

listCFOPCodes

Isolated FunctionRemote Function

function listCFOPCodes(map<string|string[]> headers, *ListCFOPCodesQueries queries) returns CFOPCodesCollection|error

List CFOPCodes

Parameters

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

queries *ListCFOPCodesQueries - Queries to be sent with the request

Return Type

CFOPCodesCollection|error - Collection of CFOPCodes

createCFOPCodes

Isolated FunctionRemote Function

function createCFOPCodes(CFOPCodes payload, map<string|string[]> headers) returns CFOPCodes|error

Create CFOPCodes

Parameters

payload CFOPCodes - The request body

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

Return Type

CFOPCodes|error - CFOPCodes created

getCFOPCodes

Isolated FunctionRemote Function

function getCFOPCodes(string dataAreaId, string cFOP, map<string|string[]> headers, *GetCFOPCodesQueries queries) returns CFOPCodes|error

Get CFOPCodes by key

Parameters

dataAreaId string - The company data area identifier

cFOP string - The c fop key field

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

queries *GetCFOPCodesQueries - Queries to be sent with the request

Return Type

CFOPCodes|error - CFOPCodes

deleteCFOPCodes

Isolated FunctionRemote Function

function deleteCFOPCodes(string dataAreaId, string cFOP, DeleteCFOPCodesHeaders headers) returns error?

Delete CFOPCodes

Parameters

dataAreaId string - The company data area identifier

cFOP string - The c fop key field

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

Return Type

error? - CFOPCodes deleted

updateCFOPCodes

Isolated FunctionRemote Function

function updateCFOPCodes(string dataAreaId, string cFOP, CFOPCodes payload, UpdateCFOPCodesHeaders headers) returns CFOPCodes|error

Update CFOPCodes

Parameters

dataAreaId string - The company data area identifier

cFOP string - The c fop key field

payload CFOPCodes - The request body

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

Return Type

CFOPCodes|error - CFOPCodes updated

listCFOPGroups

Isolated FunctionRemote Function

function listCFOPGroups(map<string|string[]> headers, *ListCFOPGroupsQueries queries) returns CFOPGroupsCollection|error

List CFOPGroups

Parameters

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

queries *ListCFOPGroupsQueries - Queries to be sent with the request

Return Type

CFOPGroupsCollection|error - Collection of CFOPGroup

createCFOPGroups

Isolated FunctionRemote Function

function createCFOPGroups(CFOPGroup payload, map<string|string[]> headers) returns CFOPGroup|error

Create CFOPGroup

Parameters

payload CFOPGroup - The request body

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

Return Type

CFOPGroup|error - CFOPGroup created

getCFOPGroups

Isolated FunctionRemote Function

function getCFOPGroups(string dataAreaId, string groupId, map<string|string[]> headers, *GetCFOPGroupsQueries queries) returns CFOPGroup|error

Get CFOPGroup by key

Parameters

dataAreaId string - The company data area identifier

groupId string - The group id key field

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

queries *GetCFOPGroupsQueries - Queries to be sent with the request

Return Type

CFOPGroup|error - CFOPGroup

deleteCFOPGroups

Isolated FunctionRemote Function

function deleteCFOPGroups(string dataAreaId, string groupId, DeleteCFOPGroupsHeaders headers) returns error?

Delete CFOPGroup

Parameters

dataAreaId string - The company data area identifier

groupId string - The group id key field

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

Return Type

error? - CFOPGroup deleted

updateCFOPGroups

Isolated FunctionRemote Function

function updateCFOPGroups(string dataAreaId, string groupId, CFOPGroup payload, UpdateCFOPGroupsHeaders headers) returns CFOPGroup|error

Update CFOPGroup

Parameters

dataAreaId string - The company data area identifier

groupId string - The group id key field

payload CFOPGroup - The request body

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

Return Type

CFOPGroup|error - CFOPGroup updated

listELParameters

Isolated FunctionRemote Function

function listELParameters(map<string|string[]> headers, *ListELParametersQueries queries) returns ELParametersCollection|error

List ELParameters

Parameters

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

queries *ListELParametersQueries - Queries to be sent with the request

Return Type

ELParametersCollection|error - Collection of ELParameter

createELParameters

Isolated FunctionRemote Function

function createELParameters(ELParameter payload, map<string|string[]> headers) returns ELParameter|error

Create ELParameter

Parameters

payload ELParameter - The request body

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

Return Type

ELParameter|error - ELParameter created

getELParameters

Isolated FunctionRemote Function

function getELParameters(string dataAreaId, int 'key, map<string|string[]> headers, *GetELParametersQueries queries) returns ELParameter|error

Get ELParameter by key

Parameters

dataAreaId string - The company data area identifier

'key int - The entity key value

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

queries *GetELParametersQueries - Queries to be sent with the request

Return Type

ELParameter|error - ELParameter

deleteELParameters

Isolated FunctionRemote Function

function deleteELParameters(string dataAreaId, int 'key, DeleteELParametersHeaders headers) returns error?

Delete ELParameter

Parameters

dataAreaId string - The company data area identifier

'key int - The entity key value

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

Return Type

error? - ELParameter deleted

updateELParameters

Isolated FunctionRemote Function

function updateELParameters(string dataAreaId, int 'key, ELParameter payload, UpdateELParametersHeaders headers) returns ELParameter|error

Update ELParameter

Parameters

dataAreaId string - The company data area identifier

'key int - The entity key value

payload ELParameter - The request body

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

Return Type

ELParameter|error - ELParameter updated

listGSTMinorCodes

Isolated FunctionRemote Function

function listGSTMinorCodes(map<string|string[]> headers, *ListGSTMinorCodesQueries queries) returns GSTMinorCodesCollection|error

List GSTMinorCodes

Parameters

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

queries *ListGSTMinorCodesQueries - Queries to be sent with the request

Return Type

GSTMinorCodesCollection|error - Collection of GSTMinorCode

createGSTMinorCodes

Isolated FunctionRemote Function

function createGSTMinorCodes(GSTMinorCode payload, map<string|string[]> headers) returns GSTMinorCode|error

Create GSTMinorCode

Parameters

payload GSTMinorCode - The request body

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

Return Type

GSTMinorCode|error - GSTMinorCode created

getGSTMinorCodes

Isolated FunctionRemote Function

function getGSTMinorCodes(string dataAreaId, string minorCode, string taxComponent, map<string|string[]> headers, *GetGSTMinorCodesQueries queries) returns GSTMinorCode|error

Get GSTMinorCode by key

Parameters

dataAreaId string - The company data area identifier

minorCode string - The minor code key field

taxComponent string - The tax component key field

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

queries *GetGSTMinorCodesQueries - Queries to be sent with the request

Return Type

GSTMinorCode|error - GSTMinorCode

deleteGSTMinorCodes

Isolated FunctionRemote Function

function deleteGSTMinorCodes(string dataAreaId, string minorCode, string taxComponent, DeleteGSTMinorCodesHeaders headers) returns error?

Delete GSTMinorCode

Parameters

dataAreaId string - The company data area identifier

minorCode string - The minor code key field

taxComponent string - The tax component key field

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

Return Type

error? - GSTMinorCode deleted

updateGSTMinorCodes

Isolated FunctionRemote Function

function updateGSTMinorCodes(string dataAreaId, string minorCode, string taxComponent, GSTMinorCode payload, UpdateGSTMinorCodesHeaders headers) returns GSTMinorCode|error

Update GSTMinorCode

Parameters

dataAreaId string - The company data area identifier

minorCode string - The minor code key field

taxComponent string - The tax component key field

payload GSTMinorCode - The request body

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

Return Type

GSTMinorCode|error - GSTMinorCode updated

listHSNCodes

Isolated FunctionRemote Function

function listHSNCodes(map<string|string[]> headers, *ListHSNCodesQueries queries) returns HSNCodesCollection|error

List HSNCodes

Parameters

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

queries *ListHSNCodesQueries - Queries to be sent with the request

Return Type

HSNCodesCollection|error - Collection of HSNCode

createHSNCodes

Isolated FunctionRemote Function

function createHSNCodes(HSNCode payload, map<string|string[]> headers) returns HSNCode|error

Create HSNCode

Parameters

payload HSNCode - The request body

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

Return Type

HSNCode|error - HSNCode created

getHSNCodes

Isolated FunctionRemote Function

function getHSNCodes(string dataAreaId, string chapter, string heading, string subheading, string countryExtension, string statisticalSuffix, map<string|string[]> headers, *GetHSNCodesQueries queries) returns HSNCode|error

Get HSNCode by key

Parameters

dataAreaId string - The company data area identifier

chapter string - The chapter key field

heading string - The heading key field

subheading string - The subheading key field

countryExtension string - The country extension key field

statisticalSuffix string - The statistical suffix key field

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

queries *GetHSNCodesQueries - Queries to be sent with the request

Return Type

HSNCode|error - HSNCode

deleteHSNCodes

Isolated FunctionRemote Function

function deleteHSNCodes(string dataAreaId, string chapter, string heading, string subheading, string countryExtension, string statisticalSuffix, DeleteHSNCodesHeaders headers) returns error?

Delete HSNCode

Parameters

dataAreaId string - The company data area identifier

chapter string - The chapter key field

heading string - The heading key field

subheading string - The subheading key field

countryExtension string - The country extension key field

statisticalSuffix string - The statistical suffix key field

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

Return Type

error? - HSNCode deleted

updateHSNCodes

Isolated FunctionRemote Function

function updateHSNCodes(string dataAreaId, string chapter, string heading, string subheading, string countryExtension, string statisticalSuffix, HSNCode payload, UpdateHSNCodesHeaders headers) returns HSNCode|error

Update HSNCode

Parameters

dataAreaId string - The company data area identifier

chapter string - The chapter key field

heading string - The heading key field

subheading string - The subheading key field

countryExtension string - The country extension key field

statisticalSuffix string - The statistical suffix key field

payload HSNCode - The request body

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

Return Type

HSNCode|error - HSNCode updated

listTaxCodeLimits

Isolated FunctionRemote Function

function listTaxCodeLimits(map<string|string[]> headers, *ListTaxCodeLimitsQueries queries) returns TaxCodeLimitsCollection|error

List TaxCodeLimits

Parameters

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

queries *ListTaxCodeLimitsQueries - Queries to be sent with the request

Return Type

TaxCodeLimitsCollection|error - Collection of TaxCodeLimit

createTaxCodeLimits

Isolated FunctionRemote Function

function createTaxCodeLimits(TaxCodeLimit payload, map<string|string[]> headers) returns TaxCodeLimit|error

Create TaxCodeLimit

Parameters

payload TaxCodeLimit - The request body

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

Return Type

TaxCodeLimit|error - TaxCodeLimit created

getTaxCodeLimits

Isolated FunctionRemote Function

function getTaxCodeLimits(string dataAreaId, string taxCodeId, string fromDate, string toDate, map<string|string[]> headers, *GetTaxCodeLimitsQueries queries) returns TaxCodeLimit|error

Get TaxCodeLimit by key

Parameters

dataAreaId string - The company data area identifier

taxCodeId string - The tax code id key field

fromDate string - The from date key field

toDate string - The to date key field

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

queries *GetTaxCodeLimitsQueries - Queries to be sent with the request

Return Type

TaxCodeLimit|error - TaxCodeLimit

deleteTaxCodeLimits

Isolated FunctionRemote Function

function deleteTaxCodeLimits(string dataAreaId, string taxCodeId, string fromDate, string toDate, DeleteTaxCodeLimitsHeaders headers) returns error?

Delete TaxCodeLimit

Parameters

dataAreaId string - The company data area identifier

taxCodeId string - The tax code id key field

fromDate string - The from date key field

toDate string - The to date key field

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

Return Type

error? - TaxCodeLimit deleted

updateTaxCodeLimits

Isolated FunctionRemote Function

function updateTaxCodeLimits(string dataAreaId, string taxCodeId, string fromDate, string toDate, TaxCodeLimit payload, UpdateTaxCodeLimitsHeaders headers) returns TaxCodeLimit|error

Update TaxCodeLimit

Parameters

dataAreaId string - The company data area identifier

taxCodeId string - The tax code id key field

fromDate string - The from date key field

toDate string - The to date key field

payload TaxCodeLimit - The request body

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

Return Type

TaxCodeLimit|error - TaxCodeLimit updated

listTaxCodes

Isolated FunctionRemote Function

function listTaxCodes(map<string|string[]> headers, *ListTaxCodesQueries queries) returns TaxCodesCollection|error

List TaxCodes

Parameters

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

queries *ListTaxCodesQueries - Queries to be sent with the request

Return Type

TaxCodesCollection|error - Collection of TaxCode

createTaxCodes

Isolated FunctionRemote Function

function createTaxCodes(TaxCode payload, map<string|string[]> headers) returns TaxCode|error

Create TaxCode

Parameters

payload TaxCode - The request body

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

Return Type

TaxCode|error - TaxCode created

getTaxCodes

Isolated FunctionRemote Function

function getTaxCodes(string dataAreaId, string taxCode, map<string|string[]> headers, *GetTaxCodesQueries queries) returns TaxCode|error

Get TaxCode by key

Parameters

dataAreaId string - The company data area identifier

taxCode string - The tax code key field

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

queries *GetTaxCodesQueries - Queries to be sent with the request

Return Type

TaxCode|error - TaxCode

deleteTaxCodes

Isolated FunctionRemote Function

function deleteTaxCodes(string dataAreaId, string taxCode, DeleteTaxCodesHeaders headers) returns error?

Delete TaxCode

Parameters

dataAreaId string - The company data area identifier

taxCode string - The tax code key field

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

Return Type

error? - TaxCode deleted

updateTaxCodes

Isolated FunctionRemote Function

function updateTaxCodes(string dataAreaId, string taxCode, TaxCode payload, UpdateTaxCodesHeaders headers) returns TaxCode|error

Update TaxCode

Parameters

dataAreaId string - The company data area identifier

taxCode string - The tax code key field

payload TaxCode - The request body

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

Return Type

TaxCode|error - TaxCode updated

listTaxGroupDatas

Isolated FunctionRemote Function

function listTaxGroupDatas(map<string|string[]> headers, *ListTaxGroupDatasQueries queries) returns TaxGroupDatasCollection|error

List TaxGroupDatas

Parameters

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

queries *ListTaxGroupDatasQueries - Queries to be sent with the request

Return Type

TaxGroupDatasCollection|error - Collection of TaxGroupData

createTaxGroupDatas

Isolated FunctionRemote Function

function createTaxGroupDatas(TaxGroupData payload, map<string|string[]> headers) returns TaxGroupData|error

Create TaxGroupData

Parameters

payload TaxGroupData - The request body

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

Return Type

TaxGroupData|error - TaxGroupData created

getTaxGroupDatas

Isolated FunctionRemote Function

function getTaxGroupDatas(string dataAreaId, string taxGroupId, string taxCodeId, map<string|string[]> headers, *GetTaxGroupDatasQueries queries) returns TaxGroupData|error

Get TaxGroupData by key

Parameters

dataAreaId string - The company data area identifier

taxGroupId string - The tax group id key field

taxCodeId string - The tax code id key field

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

queries *GetTaxGroupDatasQueries - Queries to be sent with the request

Return Type

TaxGroupData|error - TaxGroupData

deleteTaxGroupDatas

Isolated FunctionRemote Function

function deleteTaxGroupDatas(string dataAreaId, string taxGroupId, string taxCodeId, DeleteTaxGroupDatasHeaders headers) returns error?

Delete TaxGroupData

Parameters

dataAreaId string - The company data area identifier

taxGroupId string - The tax group id key field

taxCodeId string - The tax code id key field

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

Return Type

error? - TaxGroupData deleted

updateTaxGroupDatas

Isolated FunctionRemote Function

function updateTaxGroupDatas(string dataAreaId, string taxGroupId, string taxCodeId, TaxGroupData payload, UpdateTaxGroupDatasHeaders headers) returns TaxGroupData|error

Update TaxGroupData

Parameters

dataAreaId string - The company data area identifier

taxGroupId string - The tax group id key field

taxCodeId string - The tax code id key field

payload TaxGroupData - The request body

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

Return Type

TaxGroupData|error - TaxGroupData updated

listTaxGroups

Isolated FunctionRemote Function

function listTaxGroups(map<string|string[]> headers, *ListTaxGroupsQueries queries) returns TaxGroupsCollection|error

List TaxGroups

Parameters

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

queries *ListTaxGroupsQueries - Queries to be sent with the request

Return Type

TaxGroupsCollection|error - Collection of TaxGroup

createTaxGroups

Isolated FunctionRemote Function

function createTaxGroups(TaxGroup payload, map<string|string[]> headers) returns TaxGroup|error

Create TaxGroup

Parameters

payload TaxGroup - The request body

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

Return Type

TaxGroup|error - TaxGroup created

getTaxGroups

Isolated FunctionRemote Function

function getTaxGroups(string dataAreaId, string taxGroupCode, map<string|string[]> headers, *GetTaxGroupsQueries queries) returns TaxGroup|error

Get TaxGroup by key

Parameters

dataAreaId string - The company data area identifier

taxGroupCode string - The tax group code key field

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

queries *GetTaxGroupsQueries - Queries to be sent with the request

Return Type

TaxGroup|error - TaxGroup

deleteTaxGroups

Isolated FunctionRemote Function

function deleteTaxGroups(string dataAreaId, string taxGroupCode, DeleteTaxGroupsHeaders headers) returns error?

Delete TaxGroup

Parameters

dataAreaId string - The company data area identifier

taxGroupCode string - The tax group code key field

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

Return Type

error? - TaxGroup deleted

updateTaxGroups

Isolated FunctionRemote Function

function updateTaxGroups(string dataAreaId, string taxGroupCode, TaxGroup payload, UpdateTaxGroupsHeaders headers) returns TaxGroup|error

Update TaxGroup

Parameters

dataAreaId string - The company data area identifier

taxGroupCode string - The tax group code key field

payload TaxGroup - The request body

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

Return Type

TaxGroup|error - TaxGroup updated

listTaxItemGroups

Isolated FunctionRemote Function

function listTaxItemGroups(map<string|string[]> headers, *ListTaxItemGroupsQueries queries) returns TaxItemGroupsCollection|error

List TaxItemGroups

Parameters

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

queries *ListTaxItemGroupsQueries - Queries to be sent with the request

Return Type

TaxItemGroupsCollection|error - Collection of TaxItemGroup

createTaxItemGroups

Isolated FunctionRemote Function

function createTaxItemGroups(TaxItemGroup payload, map<string|string[]> headers) returns TaxItemGroup|error

Create TaxItemGroup

Parameters

payload TaxItemGroup - The request body

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

Return Type

TaxItemGroup|error - TaxItemGroup created

getTaxItemGroups

Isolated FunctionRemote Function

function getTaxItemGroups(string dataAreaId, string taxItemGroupCode, string taxCodeId, map<string|string[]> headers, *GetTaxItemGroupsQueries queries) returns TaxItemGroup|error

Get TaxItemGroup by key

Parameters

dataAreaId string - The company data area identifier

taxItemGroupCode string - The tax item group code key field

taxCodeId string - The tax code id key field

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

queries *GetTaxItemGroupsQueries - Queries to be sent with the request

Return Type

TaxItemGroup|error - TaxItemGroup

deleteTaxItemGroups

Isolated FunctionRemote Function

function deleteTaxItemGroups(string dataAreaId, string taxItemGroupCode, string taxCodeId, DeleteTaxItemGroupsHeaders headers) returns error?

Delete TaxItemGroup

Parameters

dataAreaId string - The company data area identifier

taxItemGroupCode string - The tax item group code key field

taxCodeId string - The tax code id key field

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

Return Type

error? - TaxItemGroup deleted

updateTaxItemGroups

Isolated FunctionRemote Function

function updateTaxItemGroups(string dataAreaId, string taxItemGroupCode, string taxCodeId, TaxItemGroup payload, UpdateTaxItemGroupsHeaders headers) returns TaxItemGroup|error

Update TaxItemGroup

Parameters

dataAreaId string - The company data area identifier

taxItemGroupCode string - The tax item group code key field

taxCodeId string - The tax code id key field

payload TaxItemGroup - The request body

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

Return Type

TaxItemGroup|error - TaxItemGroup updated

listTaxParameters

Isolated FunctionRemote Function

function listTaxParameters(map<string|string[]> headers, *ListTaxParametersQueries queries) returns TaxParametersCollection|error

List TaxParameters

Parameters

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

queries *ListTaxParametersQueries - Queries to be sent with the request

Return Type

TaxParametersCollection|error - Collection of TaxParameters

createTaxParameters

Isolated FunctionRemote Function

function createTaxParameters(TaxParameters payload, map<string|string[]> headers) returns TaxParameters|error

Create TaxParameters

Parameters

payload TaxParameters - The request body

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

Return Type

TaxParameters|error - TaxParameters created

getTaxParameters

Isolated FunctionRemote Function

function getTaxParameters(string dataAreaId, map<string|string[]> headers, *GetTaxParametersQueries queries) returns TaxParameters|error

Get TaxParameters by key

Parameters

dataAreaId string - The company data area identifier

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

queries *GetTaxParametersQueries - Queries to be sent with the request

Return Type

TaxParameters|error - TaxParameters

deleteTaxParameters

Isolated FunctionRemote Function

function deleteTaxParameters(string dataAreaId, DeleteTaxParametersHeaders headers) returns error?

Delete TaxParameters

Parameters

dataAreaId string - The company data area identifier

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

Return Type

error? - TaxParameters deleted

updateTaxParameters

Isolated FunctionRemote Function

function updateTaxParameters(string dataAreaId, TaxParameters payload, UpdateTaxParametersHeaders headers) returns TaxParameters|error

Update TaxParameters

Parameters

dataAreaId string - The company data area identifier

payload TaxParameters - The request body

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

Return Type

TaxParameters|error - TaxParameters updated

listTaxPeriods

Isolated FunctionRemote Function

function listTaxPeriods(map<string|string[]> headers, *ListTaxPeriodsQueries queries) returns TaxPeriodsCollection|error

List TaxPeriods

Parameters

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

queries *ListTaxPeriodsQueries - Queries to be sent with the request

Return Type

TaxPeriodsCollection|error - Collection of TaxPeriod

createTaxPeriods

Isolated FunctionRemote Function

function createTaxPeriods(TaxPeriod payload, map<string|string[]> headers) returns TaxPeriod|error

Create TaxPeriod

Parameters

payload TaxPeriod - The request body

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

Return Type

TaxPeriod|error - TaxPeriod created

getTaxPeriods

Isolated FunctionRemote Function

function getTaxPeriods(string dataAreaId, string taxPeriodId, string fromDate, string toDate, map<string|string[]> headers, *GetTaxPeriodsQueries queries) returns TaxPeriod|error

Get TaxPeriod by key

Parameters

dataAreaId string - The company data area identifier

taxPeriodId string - The tax period id key field

fromDate string - The from date key field

toDate string - The to date key field

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

queries *GetTaxPeriodsQueries - Queries to be sent with the request

Return Type

TaxPeriod|error - TaxPeriod

deleteTaxPeriods

Isolated FunctionRemote Function

function deleteTaxPeriods(string dataAreaId, string taxPeriodId, string fromDate, string toDate, DeleteTaxPeriodsHeaders headers) returns error?

Delete TaxPeriod

Parameters

dataAreaId string - The company data area identifier

taxPeriodId string - The tax period id key field

fromDate string - The from date key field

toDate string - The to date key field

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

Return Type

error? - TaxPeriod deleted

updateTaxPeriods

Isolated FunctionRemote Function

function updateTaxPeriods(string dataAreaId, string taxPeriodId, string fromDate, string toDate, TaxPeriod payload, UpdateTaxPeriodsHeaders headers) returns TaxPeriod|error

Update TaxPeriod

Parameters

dataAreaId string - The company data area identifier

taxPeriodId string - The tax period id key field

fromDate string - The from date key field

toDate string - The to date key field

payload TaxPeriod - The request body

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

Return Type

TaxPeriod|error - TaxPeriod updated

listTaxPostingGroups

Isolated FunctionRemote Function

function listTaxPostingGroups(map<string|string[]> headers, *ListTaxPostingGroupsQueries queries) returns TaxPostingGroupsCollection|error

List TaxPostingGroups

Parameters

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

queries *ListTaxPostingGroupsQueries - Queries to be sent with the request

Return Type

TaxPostingGroupsCollection|error - Collection of TaxPostingGroup

createTaxPostingGroups

Isolated FunctionRemote Function

function createTaxPostingGroups(TaxPostingGroup payload, map<string|string[]> headers) returns TaxPostingGroup|error

Create TaxPostingGroup

Parameters

payload TaxPostingGroup - The request body

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

Return Type

TaxPostingGroup|error - TaxPostingGroup created

getTaxPostingGroups

Isolated FunctionRemote Function

function getTaxPostingGroups(string dataAreaId, string taxPostingGroupCode, map<string|string[]> headers, *GetTaxPostingGroupsQueries queries) returns TaxPostingGroup|error

Get TaxPostingGroup by key

Parameters

dataAreaId string - The company data area identifier

taxPostingGroupCode string - The tax posting group code key field

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

queries *GetTaxPostingGroupsQueries - Queries to be sent with the request

Return Type

TaxPostingGroup|error - TaxPostingGroup

deleteTaxPostingGroups

Isolated FunctionRemote Function

function deleteTaxPostingGroups(string dataAreaId, string taxPostingGroupCode, DeleteTaxPostingGroupsHeaders headers) returns error?

Delete TaxPostingGroup

Parameters

dataAreaId string - The company data area identifier

taxPostingGroupCode string - The tax posting group code key field

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

Return Type

error? - TaxPostingGroup deleted

updateTaxPostingGroups

Isolated FunctionRemote Function

function updateTaxPostingGroups(string dataAreaId, string taxPostingGroupCode, TaxPostingGroup payload, UpdateTaxPostingGroupsHeaders headers) returns TaxPostingGroup|error

Update TaxPostingGroup

Parameters

dataAreaId string - The company data area identifier

taxPostingGroupCode string - The tax posting group code key field

payload TaxPostingGroup - The request body

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

Return Type

TaxPostingGroup|error - TaxPostingGroup updated

listTaxRegions

Isolated FunctionRemote Function

function listTaxRegions(map<string|string[]> headers, *ListTaxRegionsQueries queries) returns TaxRegionsCollection|error

List TaxRegions

Parameters

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

queries *ListTaxRegionsQueries - Queries to be sent with the request

Return Type

TaxRegionsCollection|error - Collection of TaxRegion

createTaxRegions

Isolated FunctionRemote Function

function createTaxRegions(TaxRegion payload, map<string|string[]> headers) returns TaxRegion|error

Create TaxRegion

Parameters

payload TaxRegion - The request body

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

Return Type

TaxRegion|error - TaxRegion created

getTaxRegions

Isolated FunctionRemote Function

function getTaxRegions(string locationId, string validFrom, map<string|string[]> headers, *GetTaxRegionsQueries queries) returns TaxRegion|error

Get TaxRegion by key

Parameters

locationId string - The location id key field

validFrom string - The valid from key field

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

queries *GetTaxRegionsQueries - Queries to be sent with the request

Return Type

TaxRegion|error - TaxRegion

deleteTaxRegions

Isolated FunctionRemote Function

function deleteTaxRegions(string locationId, string validFrom, DeleteTaxRegionsHeaders headers) returns error?

Delete TaxRegion

Parameters

locationId string - The location id key field

validFrom string - The valid from key field

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

Return Type

error? - TaxRegion deleted

updateTaxRegions

Isolated FunctionRemote Function

function updateTaxRegions(string locationId, string validFrom, TaxRegion payload, UpdateTaxRegionsHeaders headers) returns TaxRegion|error

Update TaxRegion

Parameters

locationId string - The location id key field

validFrom string - The valid from key field

payload TaxRegion - The request body

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

Return Type

TaxRegion|error - TaxRegion updated

listTaxTables

Isolated FunctionRemote Function

function listTaxTables(map<string|string[]> headers, *ListTaxTablesQueries queries) returns TaxTablesCollection|error

List TaxTables

Parameters

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

queries *ListTaxTablesQueries - Queries to be sent with the request

Return Type

TaxTablesCollection|error - Collection of TaxTable

createTaxTables

Isolated FunctionRemote Function

function createTaxTables(TaxTable payload, map<string|string[]> headers) returns TaxTable|error

Create TaxTable

Parameters

payload TaxTable - The request body

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

Return Type

TaxTable|error - TaxTable created

getTaxTables

Isolated FunctionRemote Function

function getTaxTables(string dataAreaId, string module, string code, map<string|string[]> headers, *GetTaxTablesQueries queries) returns TaxTable|error

Get TaxTable by key

Parameters

dataAreaId string - The company data area identifier

module string - The module key field

code string - The code key field

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

queries *GetTaxTablesQueries - Queries to be sent with the request

Return Type

TaxTable|error - TaxTable

deleteTaxTables

Isolated FunctionRemote Function

function deleteTaxTables(string dataAreaId, string module, string code, DeleteTaxTablesHeaders headers) returns error?

Delete TaxTable

Parameters

dataAreaId string - The company data area identifier

module string - The module key field

code string - The code key field

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

Return Type

error? - TaxTable deleted

updateTaxTables

Isolated FunctionRemote Function

function updateTaxTables(string dataAreaId, string module, string code, TaxTable payload, UpdateTaxTablesHeaders headers) returns TaxTable|error

Update TaxTable

Parameters

dataAreaId string - The company data area identifier

module string - The module key field

code string - The code key field

payload TaxTable - The request body

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

Return Type

TaxTable|error - TaxTable updated

listTaxationCode

Isolated FunctionRemote Function

function listTaxationCode(map<string|string[]> headers, *ListTaxationCodeQueries queries) returns TaxationCodeCollection|error

List TaxationCode

Parameters

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

queries *ListTaxationCodeQueries - Queries to be sent with the request

Return Type

TaxationCodeCollection|error - Collection of TaxationCode

createTaxationCode

Isolated FunctionRemote Function

function createTaxationCode(TaxationCode payload, map<string|string[]> headers) returns TaxationCode|error

Create TaxationCode

Parameters

payload TaxationCode - The request body

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

Return Type

TaxationCode|error - TaxationCode created

getTaxationCode

Isolated FunctionRemote Function

function getTaxationCode(string dataAreaId, string taxType, string taxationCode, string fiscalValue, map<string|string[]> headers, *GetTaxationCodeQueries queries) returns TaxationCode|error

Get TaxationCode by key

Parameters

dataAreaId string - The company data area identifier

taxType string - The tax type key field

taxationCode string - The taxation code key field

fiscalValue string - The fiscal value key field

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

queries *GetTaxationCodeQueries - Queries to be sent with the request

Return Type

TaxationCode|error - TaxationCode

deleteTaxationCode

Isolated FunctionRemote Function

function deleteTaxationCode(string dataAreaId, string taxType, string taxationCode, string fiscalValue, DeleteTaxationCodeHeaders headers) returns error?

Delete TaxationCode

Parameters

dataAreaId string - The company data area identifier

taxType string - The tax type key field

taxationCode string - The taxation code key field

fiscalValue string - The fiscal value key field

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

Return Type

error? - TaxationCode deleted

updateTaxationCode

Isolated FunctionRemote Function

function updateTaxationCode(string dataAreaId, string taxType, string taxationCode, string fiscalValue, TaxationCode payload, UpdateTaxationCodeHeaders headers) returns TaxationCode|error

Update TaxationCode

Parameters

dataAreaId string - The company data area identifier

taxType string - The tax type key field

taxationCode string - The taxation code key field

fiscalValue string - The fiscal value key field

payload TaxationCode - The request body

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

Return Type

TaxationCode|error - TaxationCode updated

listTaxesMatrices

Isolated FunctionRemote Function

function listTaxesMatrices(map<string|string[]> headers, *ListTaxesMatricesQueries queries) returns TaxesMatricesCollection|error

List TaxesMatrices

Parameters

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

queries *ListTaxesMatricesQueries - Queries to be sent with the request

Return Type

TaxesMatricesCollection|error - Collection of TaxesMatrix

createTaxesMatrices

Isolated FunctionRemote Function

function createTaxesMatrices(TaxesMatrix payload, map<string|string[]> headers) returns TaxesMatrix|error

Create TaxesMatrix

Parameters

payload TaxesMatrix - The request body

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

Return Type

TaxesMatrix|error - TaxesMatrix created

getTaxesMatrices

Isolated FunctionRemote Function

function getTaxesMatrices(string dataAreaId, string fiscalEstablishmentGroupId, string cFOPGroupId, string 'type, string accountRelation, string itemRelation, map<string|string[]> headers, *GetTaxesMatricesQueries queries) returns TaxesMatrix|error

Get TaxesMatrix by key

Parameters

dataAreaId string - The company data area identifier

fiscalEstablishmentGroupId string - The fiscal establishment group id key field

cFOPGroupId string - The c fop group id key field

'type string - The entity type identifier

accountRelation string - The account relation key field

itemRelation string - The item relation key field

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

queries *GetTaxesMatricesQueries - Queries to be sent with the request

Return Type

TaxesMatrix|error - TaxesMatrix

deleteTaxesMatrices

Isolated FunctionRemote Function

function deleteTaxesMatrices(string dataAreaId, string fiscalEstablishmentGroupId, string cFOPGroupId, string 'type, string accountRelation, string itemRelation, DeleteTaxesMatricesHeaders headers) returns error?

Delete TaxesMatrix

Parameters

dataAreaId string - The company data area identifier

fiscalEstablishmentGroupId string - The fiscal establishment group id key field

cFOPGroupId string - The c fop group id key field

'type string - The entity type identifier

accountRelation string - The account relation key field

itemRelation string - The item relation key field

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

Return Type

error? - TaxesMatrix deleted

updateTaxesMatrices

Isolated FunctionRemote Function

function updateTaxesMatrices(string dataAreaId, string fiscalEstablishmentGroupId, string cFOPGroupId, string 'type, string accountRelation, string itemRelation, TaxesMatrix payload, UpdateTaxesMatricesHeaders headers) returns TaxesMatrix|error

Update TaxesMatrix

Parameters

dataAreaId string - The company data area identifier

fiscalEstablishmentGroupId string - The fiscal establishment group id key field

cFOPGroupId string - The c fop group id key field

'type string - The entity type identifier

accountRelation string - The account relation key field

itemRelation string - The item relation key field

payload TaxesMatrix - The request body

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

Return Type

TaxesMatrix|error - TaxesMatrix updated

Records

microsoft.dynamics365.finance.tax: CFOPCodes

Fields

searchName? string -

fiscalReferenceLegalText? string -

purpose? CFOPPurposeBR -

direction? FiscalDocDirectionBR -

name? string -

deliveryCFOP? string -

dataAreaId? string -

fiscalDocumentSourceText? string -

fiscalReferenceRequired? NoYes -

considerInCIAP? NoYes -

fiscalDocumentText? string -

cFOP? string -

location? CustVendLocationBR -

microsoft.dynamics365.finance.tax: CFOPCodesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *CFOPCodesCollectionAllOf2

value CFOPCodes[]
anydata...

microsoft.dynamics365.finance.tax: CFOPCodesCollectionAllOf2

Fields

value? CFOPCodes[] -

microsoft.dynamics365.finance.tax: CFOPGroup

Fields

dataAreaId? string -

description? string -

groupId? string -

microsoft.dynamics365.finance.tax: CFOPGroupsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *CFOPGroupsCollectionAllOf2

value CFOPGroup[]
anydata...

microsoft.dynamics365.finance.tax: CFOPGroupsCollectionAllOf2

Fields

value? CFOPGroup[] -

microsoft.dynamics365.finance.tax: ConnectionConfig

Closed record

Fields

auth? OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

microsoft.dynamics365.finance.tax: DeleteCFOPCodesHeaders

Represents the Headers record for the operation: deleteCFOPCodes

Fields

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

microsoft.dynamics365.finance.tax: DeleteCFOPGroupsHeaders

Represents the Headers record for the operation: deleteCFOPGroups

Fields

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

microsoft.dynamics365.finance.tax: DeleteELParametersHeaders

Represents the Headers record for the operation: deleteELParameters

Fields

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

microsoft.dynamics365.finance.tax: DeleteGSTMinorCodesHeaders

Represents the Headers record for the operation: deleteGSTMinorCodes

Fields

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

microsoft.dynamics365.finance.tax: DeleteHSNCodesHeaders

Represents the Headers record for the operation: deleteHSNCodes

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxationCodeHeaders

Represents the Headers record for the operation: deleteTaxationCode

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxCodeLimitsHeaders

Represents the Headers record for the operation: deleteTaxCodeLimits

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxCodesHeaders

Represents the Headers record for the operation: deleteTaxCodes

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxesMatricesHeaders

Represents the Headers record for the operation: deleteTaxesMatrices

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxGroupDatasHeaders

Represents the Headers record for the operation: deleteTaxGroupDatas

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxGroupsHeaders

Represents the Headers record for the operation: deleteTaxGroups

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxItemGroupsHeaders

Represents the Headers record for the operation: deleteTaxItemGroups

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxParametersHeaders

Represents the Headers record for the operation: deleteTaxParameters

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxPeriodsHeaders

Represents the Headers record for the operation: deleteTaxPeriods

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxPostingGroupsHeaders

Represents the Headers record for the operation: deleteTaxPostingGroups

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxRegionsHeaders

Represents the Headers record for the operation: deleteTaxRegions

Fields

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

microsoft.dynamics365.finance.tax: DeleteTaxTablesHeaders

Represents the Headers record for the operation: deleteTaxTables

Fields

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

microsoft.dynamics365.finance.tax: ELParameter

Fields

dimensionAttributeName? string -

isActiveMultiBranch? NoYes -

dataAreaId? string -

cOALookupActive? NoYes -

takeSameNumForSameVoucher? NoYes -

maxBatchSessionsforSendingPool? Signed32 -

branchId? string -

hcmWorkerPersonnelNumber? string -

key? Signed32 -

dimensionMainAccountActivate? NoYes -

branchDescription? string -

microsoft.dynamics365.finance.tax: ELParametersCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *ELParametersCollectionAllOf2

value ELParameter[]
anydata...

microsoft.dynamics365.finance.tax: ELParametersCollectionAllOf2

Fields

value? ELParameter[] -

microsoft.dynamics365.finance.tax: GetCFOPCodesQueries

Represents the Queries record for the operation: getCFOPCodes

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.tax: GetCFOPGroupsQueries

Represents the Queries record for the operation: getCFOPGroups

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.tax: GetELParametersQueries

Represents the Queries record for the operation: getELParameters

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.tax: GetGSTMinorCodesQueries

Represents the Queries record for the operation: getGSTMinorCodes

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.tax: GetHSNCodesQueries

Represents the Queries record for the operation: getHSNCodes

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.tax: GetTaxationCodeQueries

Represents the Queries record for the operation: getTaxationCode

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.tax: GetTaxCodeLimitsQueries

Represents the Queries record for the operation: getTaxCodeLimits

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.tax: GetTaxCodesQueries

Represents the Queries record for the operation: getTaxCodes

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.tax: GetTaxesMatricesQueries

Represents the Queries record for the operation: getTaxesMatrices

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.tax: GetTaxGroupDatasQueries

Represents the Queries record for the operation: getTaxGroupDatas

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.tax: GetTaxGroupsQueries

Represents the Queries record for the operation: getTaxGroups

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.tax: GetTaxItemGroupsQueries

Represents the Queries record for the operation: getTaxItemGroups

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.tax: GetTaxParametersQueries

Represents the Queries record for the operation: getTaxParameters

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.tax: GetTaxPeriodsQueries

Represents the Queries record for the operation: getTaxPeriods

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.tax: GetTaxPostingGroupsQueries

Represents the Queries record for the operation: getTaxPostingGroups

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.tax: GetTaxRegionsQueries

Represents the Queries record for the operation: getTaxRegions

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.tax: GetTaxTablesQueries

Represents the Queries record for the operation: getTaxTables

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.tax: GSTMinorCode

Fields

dataAreaId? string -

taxComponent? string -

description? string -

minorCode? string -

microsoft.dynamics365.finance.tax: GSTMinorCodesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *GSTMinorCodesCollectionAllOf2

value GSTMinorCode[]
anydata...

microsoft.dynamics365.finance.tax: GSTMinorCodesCollectionAllOf2

Fields

value? GSTMinorCode[] -

microsoft.dynamics365.finance.tax: HSNCode

Fields

dataAreaId? string -

heading? string -

subheading? string -

description? string -

chapter? string -

statisticalSuffix? string -

code? string -

countryExtension? string -

microsoft.dynamics365.finance.tax: HSNCodesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *HSNCodesCollectionAllOf2

value HSNCode[]
anydata...

microsoft.dynamics365.finance.tax: HSNCodesCollectionAllOf2

Fields

value? HSNCode[] -

microsoft.dynamics365.finance.tax: ListCFOPCodesQueries

Represents the Queries record for the operation: listCFOPCodes

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.tax: ListCFOPGroupsQueries

Represents the Queries record for the operation: listCFOPGroups

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.tax: ListELParametersQueries

Represents the Queries record for the operation: listELParameters

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.tax: ListGSTMinorCodesQueries

Represents the Queries record for the operation: listGSTMinorCodes

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.tax: ListHSNCodesQueries

Represents the Queries record for the operation: listHSNCodes

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.tax: ListTaxationCodeQueries

Represents the Queries record for the operation: listTaxationCode

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.tax: ListTaxCodeLimitsQueries

Represents the Queries record for the operation: listTaxCodeLimits

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.tax: ListTaxCodesQueries

Represents the Queries record for the operation: listTaxCodes

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.tax: ListTaxesMatricesQueries

Represents the Queries record for the operation: listTaxesMatrices

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.tax: ListTaxGroupDatasQueries

Represents the Queries record for the operation: listTaxGroupDatas

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.tax: ListTaxGroupsQueries

Represents the Queries record for the operation: listTaxGroups

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.tax: ListTaxItemGroupsQueries

Represents the Queries record for the operation: listTaxItemGroups

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.tax: ListTaxParametersQueries

Represents the Queries record for the operation: listTaxParameters

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.tax: ListTaxPeriodsQueries

Represents the Queries record for the operation: listTaxPeriods

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.tax: ListTaxPostingGroupsQueries

Represents the Queries record for the operation: listTaxPostingGroups

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.tax: ListTaxRegionsQueries

Represents the Queries record for the operation: listTaxRegions

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.tax: ListTaxTablesQueries

Represents the Queries record for the operation: listTaxTables

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.tax: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields

Fields Included from *OAuth2ClientCredentialsGrantConfig

tokenUrl string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

tokenUrl string(default "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token") - Token URL

microsoft.dynamics365.finance.tax: ODataCollection

Fields

odataNextLink? string -

odataCount? int -

odataContext? string -

microsoft.dynamics365.finance.tax: TaxationCode

Fields

dataAreaId? string -

taxType? TaxTypeBR -

outputCode? string -

description? string -

fiscalValue? TaxFiscalValueBR -

fromDate? string -

toDate? string -

taxationCode? string -

spedCode? string -

inputCode? string -

microsoft.dynamics365.finance.tax: TaxationCodeCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxationCodeCollectionAllOf2

value TaxationCode[]
anydata...

microsoft.dynamics365.finance.tax: TaxationCodeCollectionAllOf2

Fields

value? TaxationCode[] -

microsoft.dynamics365.finance.tax: TaxCode

Fields

reportingCodeTaxablePurchases? Signed32 -

vATChargeSource? VATChargeSourceRU -

reportingCodeTaxFreeBuyDebitNote? Signed32 -

reportingCodeUseTaxOffsetCreditNote? Signed32 -

taxationCode? string -

isInvestment? NoYes -

reportingCodeSalesTaxReceivableCreditNote? Signed32 -

dataAreaId? string -

diotAddInfo? NoYes -

taxCalculationMethod? TaxCalcMode -

reportingCodeTaxOutgoingDebitNote? Signed32 -

reportingCodeBaseOutgoingDebitNote? Signed32 -

reportingCodeTaxFreePurchase? Signed32 -

japanTaxType? TaxTypeJP -

domesticCustomsPractice? NoYes -

taxLimitBase? TaxLimitBase -

reportingCodeTaxFreeSaleCreditNote? Signed32 -

reportingCodeTaxableImport? Signed32 -

reportingCodeUseTax? Signed32 -

taxSubstitutionMethod? TaxSubstitutionEnumBR -

reportingCodeTaxFreeSale? Signed32 -

negativeTax? NoYes -

unrealizedTax? NoYes -

packingDutySortCode? string -

reportingCodeSalesTaxPayableCreditNote? Signed32 -

taxCountryRegionType? CountryRegionType -

descriptionQRBill? string -

packingDuty? NoYes -

taxBase? TaxBaseType -

mexicoTaxType? TaxTypeMX -

reportingCodeUseTaxCreditNote? Signed32 -

taxType? TaxTypeTH -

brazilTaxType? TaxTypeBR -

notEUSalesList? NoYes -

reportingCodeTaxableSales? Signed32 -

reportingCodeTaxablePurchasesCreditNote? Signed32 -

reportingCodeTaxFreePurchaseCreditNote? Signed32 -

singaporeTaxType? TaxTypeSG -

taxSubstitutionCalculationMethod? TaxSubstitutionBaseRedCalculationModeBR -

reportingCodeSalesTaxReceivable? Signed32 -

taxPeriodId? string -

reportingCodeTaxableSalesCreditNote? Signed32 -

reportingCodeSalesTaxPayable? Signed32 -

taxCode? string -

printCode? string -

reportingCodeUseTaxOffset? Signed32 -

taxRoundOffType? RoundOffType -

taxUnitId? string -

fiscalValue? TaxFiscalValueBR -

calculateUnitTaxBeforeSalesTax? NoYes -

taxCurrencyCodeId? string -

reportingCodeTaxableImportOffset? Signed32 -

isGST? NoYes -

typeOfTax? TaxTypeW -

paymentTaxCodeId? string -

taxRoundOff? decimal -

taxName? string -

revenueCode? string -

reportingCodeTaxableImportOffsetCreditNote? Signed32 -

excludeFromInvoice? NoYes -

taxOnTax? string -

reportingCodeTaxFreeSalesDebitNote? Signed32 -

retainedTax? NoYes -

includedTax? NoYes -

taxVatReportCategoryCode? string -

reportingCodeTaxableImportCreditNote? Signed32 -

reportingCodeTaxIncomingDebitNote? Signed32 -

taxPostingGroupId? string -

reportingCodeBaseIncomingDebitNote? Signed32 -

printCodeType? TaxWriteSelection -

microsoft.dynamics365.finance.tax: TaxCodeLimit

Fields

dataAreaId? string -

taxCodeId? string -

fromDate? string -

toDate? string -

maximumSalesTax? decimal -

minimumSalesTax? decimal -

microsoft.dynamics365.finance.tax: TaxCodeLimitsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxCodeLimitsCollectionAllOf2

value TaxCodeLimit[]
anydata...

microsoft.dynamics365.finance.tax: TaxCodeLimitsCollectionAllOf2

Fields

value? TaxCodeLimit[] -

microsoft.dynamics365.finance.tax: TaxCodesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxCodesCollectionAllOf2

value TaxCode[]
anydata...

microsoft.dynamics365.finance.tax: TaxCodesCollectionAllOf2

Fields

value? TaxCode[] -

microsoft.dynamics365.finance.tax: TaxesMatricesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxesMatricesCollectionAllOf2

value TaxesMatrix[]
anydata...

microsoft.dynamics365.finance.tax: TaxesMatricesCollectionAllOf2

Fields

value? TaxesMatrix[] -

microsoft.dynamics365.finance.tax: TaxesMatrix

Fields

salesTaxGroup? string -

dataAreaId? string -

'type? CustVendTypeBR -

itemCode? TableGroupAll -

isUsedForServiceItems? NoYes -

itemSalesTaxGroup? string -

fiscalEstablishmentGroupId? string -

cFOPGroupId? string -

accountCode? TableGroupAll -

isUsedForFreeTextInvoice? NoYes -

accountRelation? string -

itemRelation? string -

microsoft.dynamics365.finance.tax: TaxGroup

Fields

defaultCriteriaCountryId? string -

roundingBy? TaxGroupRounding -

description? string -

eUTradeW? NoYes -

invoicePrintDetails? TaxPrintDetail -

taxGroupCode? string -

defaultCriteriaZipCodeId? string -

fillSalesDateW? FillSalesDateW -

dataAreaId? string -

taxReverseOnCashDiscount? NoYes -

defaultCriteriaStateId? string -

defaultCriteriaCityId? string -

defaultCriteriaCountyId? string -

mandatorySalesDateW? NoYes -

dateOfVATRegisterFilling? FillVATDueDateW -

microsoft.dynamics365.finance.tax: TaxGroupData

Fields

dataAreaId? string -

taxCodeId? string -

reverseCharge? NoYes -

taxGroupId? string -

exemptTax? NoYes -

taxExemptCodeId? string -

brazilianTaxationCode? string -

useTax? NoYes -

intracomVAT? NoYes -

microsoft.dynamics365.finance.tax: TaxGroupDatasCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxGroupDatasCollectionAllOf2

value TaxGroupData[]
anydata...

microsoft.dynamics365.finance.tax: TaxGroupDatasCollectionAllOf2

Fields

value? TaxGroupData[] -

microsoft.dynamics365.finance.tax: TaxGroupsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxGroupsCollectionAllOf2

value TaxGroup[]
anydata...

microsoft.dynamics365.finance.tax: TaxGroupsCollectionAllOf2

Fields

value? TaxGroup[] -

microsoft.dynamics365.finance.tax: TaxItemGroup

Fields

eUSalesListType? EUSalesListType -

dataAreaId? string -

taxCodeId? string -

description? string -

taxExemptCode? string -

withoutTaxCredit? NoYes -

exemptTax? NoYes -

taxItemGroupCode? string -

taxationCode? string -

microsoft.dynamics365.finance.tax: TaxItemGroupsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxItemGroupsCollectionAllOf2

value TaxItemGroup[]
anydata...

microsoft.dynamics365.finance.tax: TaxItemGroupsCollectionAllOf2

Fields

value? TaxItemGroup[] -

microsoft.dynamics365.finance.tax: TaxParameters

Fields

gSTVendorUrl? string -

incommingVATPayment? NoYes -

taxCalculationDate? TaxCalculationDateType -

legalEntityforIntercompanyTax? TaxObligationCompany -

bASSolutionName? string -

gSTGAFVersion? string -

gSTAuditFileFormatName? string -

bankExchangeRate? NoYes -

isTaxBranchEnabled? NoYes -

validateTaxCode? NoYes -

dataAreaId? string -

bASFormatName? string -

adjustTaxForOverUnderpayment? NoYes -

bASVendorUrl? string -

useSelfBilledInvoice? NoYes -

defaultInvoiceType? InvoiceTypeMY -

cashDiscountIsAppliedInTheInvoice? NoYes -

isConsumptionTaxReportsEnabled? NoYes -

salesTaxTaxationRules? NoYes -

autoTaxSearch? NoYes -

calculationPrinciple? TaxCalcPrin -

fixedOffsetPosting? NoYes -

restoredVATCalculationMethod? RestoredVATCalcMethodRU -

reverseSalesTaxOnCashDiscount? NoYes -

dateForSecondTaxRaise? string -

amountsIncludeTaxInJournals? NoYes -

includeTaxValueInGSTSummary? NoYes -

includeAdjustmentOnReport? NoYes -

checkSalesTaxGroupIntersection? CheckTaxGroups -

gSTExemptPrintCode? string -

restoredVATGainCalculationMethod? RestoredVATGainCalcMethodRU -

salesTaxReceivableExchangeRateType? string -

gSTInvoiceFormat? TaxGSTInvoiceFormatMY -

mandatoryTaxDirection? NoYes -

useVATDueDateInReports? NoYes -

conditionalTax? NoYes -

includeDelimiterInGSTSummary? NoYes -

defaultSalesTaxGroup? string -

taxPerInvoiceLine? NoYes -

checkSalesTaxTransaction? NoYes -

gSTSolutionName? string -

defaultItemSalesTaxGroup? string -

salesTaxPayableExchangeRateType? string -

includeTaxCodeInGSTSummary? NoYes -

deductTaxBeforeCashDiscountCalculation? NoYes -

exchangeRateDifferenceDocumentType? CustVendExchRateDiffDocTypeRU -

gSTSummaryDelimiter? string -

microsoft.dynamics365.finance.tax: TaxParametersCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxParametersCollectionAllOf2

value TaxParameters[]
anydata...

microsoft.dynamics365.finance.tax: TaxParametersCollectionAllOf2

Fields

value? TaxParameters[] -

microsoft.dynamics365.finance.tax: TaxPeriod

Fields

dataAreaId? string -

periodInterval? PeriodUnit -

paymentTermId? string -

taxPaymentVersion? Signed32 -

description? string -

taxAuthorityId? string -

fromDate? string -

toDate? string -

numberOfUnit? Signed32 -

taxPeriodId? string -

microsoft.dynamics365.finance.tax: TaxPeriodsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxPeriodsCollectionAllOf2

value TaxPeriod[]
anydata...

microsoft.dynamics365.finance.tax: TaxPeriodsCollectionAllOf2

Fields

value? TaxPeriod[] -

microsoft.dynamics365.finance.tax: TaxPostingGroup

Fields

taxOutgoingDiffOffsetMainAccountIdDisplayValue? string -

taxUnrealizedReceivablesMainAccountIdDisplayValue? string -

taxSalesExpenseMainAccountIdDisplayValue? string -

description? string -

useTaxMainAccountIdDisplayValue? string -

taxReceivableMainAccountIdDisplayValue? string -

taxReceivableShortTermMainAccountIdDisplayValue? string -

taxPostingGroupCode? string -

taxOutgoingDifferenceMainAccountIdDisplayValue? string -

dataAreaId? string -

taxIncomingDifferenceMainAccountIdDisplayValue? string -

taxSettlementMainAccountIdDisplayValue? string -

taxUnrealizedPayablesMainAccountIdDisplayValue? string -

taxIncomingDiffOffsetMainAccountIdDisplayValue? string -

useTaxPayableMainAccountIdDisplayValue? string -

taxFromVendorCashDiscountMainAccountIdDisplayValue? string -

taxPayableMainAccountIdDisplayValue? string -

taxFromCustomerCashDiscountMainAccountIdDisplayValue? string -

taxReceivableLongTermMainAccountIdDisplayValue? string -

microsoft.dynamics365.finance.tax: TaxPostingGroupsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxPostingGroupsCollectionAllOf2

value TaxPostingGroup[]
anydata...

microsoft.dynamics365.finance.tax: TaxPostingGroupsCollectionAllOf2

Fields

value? TaxPostingGroup[] -

microsoft.dynamics365.finance.tax: TaxRegion

Fields

countryRegionISOCode? string -

taxRegionName? string -

address? string -

zipCode? string -

locationId? string -

city? string -

county? string -

countryRegionId? string -

state? string -

validTo? string -

validFrom? string -

streetNumber? string -

street? string -

microsoft.dynamics365.finance.tax: TaxRegionsCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxRegionsCollectionAllOf2

value TaxRegion[]
anydata...

microsoft.dynamics365.finance.tax: TaxRegionsCollectionAllOf2

Fields

value? TaxRegion[] -

microsoft.dynamics365.finance.tax: TaxTable

Fields

dataAreaId? string -

typeOfTax? TaxTypeW -

expenseCode? string -

mainAccountDisplayValue? string -

'module? RTax25TaxModule -

code? string -

microsoft.dynamics365.finance.tax: TaxTablesCollection

Fields

Fields Included from *ODataCollection

odataNextLink string
odataCount int
odataContext string
anydata...

Fields Included from *TaxTablesCollectionAllOf2

value TaxTable[]
anydata...

microsoft.dynamics365.finance.tax: TaxTablesCollectionAllOf2

Fields

value? TaxTable[] -

microsoft.dynamics365.finance.tax: UpdateCFOPCodesHeaders

Represents the Headers record for the operation: updateCFOPCodes

Fields

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

microsoft.dynamics365.finance.tax: UpdateCFOPGroupsHeaders

Represents the Headers record for the operation: updateCFOPGroups

Fields

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

microsoft.dynamics365.finance.tax: UpdateELParametersHeaders

Represents the Headers record for the operation: updateELParameters

Fields

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

microsoft.dynamics365.finance.tax: UpdateGSTMinorCodesHeaders

Represents the Headers record for the operation: updateGSTMinorCodes

Fields

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

microsoft.dynamics365.finance.tax: UpdateHSNCodesHeaders

Represents the Headers record for the operation: updateHSNCodes

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxationCodeHeaders

Represents the Headers record for the operation: updateTaxationCode

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxCodeLimitsHeaders

Represents the Headers record for the operation: updateTaxCodeLimits

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxCodesHeaders

Represents the Headers record for the operation: updateTaxCodes

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxesMatricesHeaders

Represents the Headers record for the operation: updateTaxesMatrices

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxGroupDatasHeaders

Represents the Headers record for the operation: updateTaxGroupDatas

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxGroupsHeaders

Represents the Headers record for the operation: updateTaxGroups

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxItemGroupsHeaders

Represents the Headers record for the operation: updateTaxItemGroups

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxParametersHeaders

Represents the Headers record for the operation: updateTaxParameters

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxPeriodsHeaders

Represents the Headers record for the operation: updateTaxPeriods

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxPostingGroupsHeaders

Represents the Headers record for the operation: updateTaxPostingGroups

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxRegionsHeaders

Represents the Headers record for the operation: updateTaxRegions

Fields

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

microsoft.dynamics365.finance.tax: UpdateTaxTablesHeaders

Represents the Headers record for the operation: updateTaxTables

Fields

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

Union types

microsoft.dynamics365.finance.tax: TaxCalcPrin

"Total"|"Line"

TaxCalcPrin

microsoft.dynamics365.finance.tax: TaxLimitBase

TaxLimitBase

microsoft.dynamics365.finance.tax: FillVATDueDateW

FillVATDueDateW

microsoft.dynamics365.finance.tax: RoundOffType

"Ordinary"|"RoundDown"|"RoundUp"

RoundOffType

microsoft.dynamics365.finance.tax: TaxTypeMX

"Blank"|"ISR"|"IVA"|"IEPS"

TaxTypeMX

microsoft.dynamics365.finance.tax: TaxGroupRounding

"TaxCode"|"TaxCodeSet"

TaxGroupRounding

microsoft.dynamics365.finance.tax: CustVendExchRateDiffDocTypeRU

"Invoice"|"FirstByDate"

CustVendExchRateDiffDocTypeRU

microsoft.dynamics365.finance.tax: InvoiceTypeMY

"Invoice"|"GST"|"SelfBilled"|"ServiceInvoice"

InvoiceTypeMY

microsoft.dynamics365.finance.tax: TaxCalcMode

"FullAmounts"|"Interval"

TaxCalcMode

microsoft.dynamics365.finance.tax: VATChargeSourceRU

"VendorFunds"|"OwnFunds"

VATChargeSourceRU

microsoft.dynamics365.finance.tax: CFOPPurposeBR

"None"|"Shipment"|"FiscalEstablishmentTransfer"|"Return"|"ReturnOrder"

CFOPPurposeBR

microsoft.dynamics365.finance.tax: TaxWriteSelection

"PrintCode"|"TaxRate"

TaxWriteSelection

microsoft.dynamics365.finance.tax: CountryRegionType

CountryRegionType

microsoft.dynamics365.finance.tax: TaxTypeSG

"Standard"|"Zero"|"Exempt"

TaxTypeSG

microsoft.dynamics365.finance.tax: EUSalesListType

"NotAssigned"|"Item"|"Service"|"Investment"|"GoodsP4Sect33_LV"

EUSalesListType

microsoft.dynamics365.finance.tax: TaxBaseType

TaxBaseType

microsoft.dynamics365.finance.tax: FillSalesDateW

"Manually"|"VATDueDate"|"DocumentDate"|"PostingDate"|"LastDeliveryDate"

FillSalesDateW

microsoft.dynamics365.finance.tax: CheckTaxGroups

"None"|"Warning"|"Error"

CheckTaxGroups

microsoft.dynamics365.finance.tax: TaxSubstitutionBaseRedCalculationModeBR

"OwnOperationIpiAndMarkup"|"OwnOperationOnly"

TaxSubstitutionBaseRedCalculationModeBR

microsoft.dynamics365.finance.tax: TaxGSTInvoiceFormatMY

"Full"|"Simplified"

TaxGSTInvoiceFormatMY

microsoft.dynamics365.finance.tax: TaxTypeTH

"Normal"|"AverageUnrealized"|"AverageRealized"

TaxTypeTH

microsoft.dynamics365.finance.tax: CustVendLocationBR

"SameState"|"OtherState"|"OutsideCountry"

CustVendLocationBR

microsoft.dynamics365.finance.tax: TaxObligationCompany

"Destination"|"Source"

TaxObligationCompany

microsoft.dynamics365.finance.tax: RestoredVATCalcMethodRU

"Mixed"|"ByFactor"

RestoredVATCalcMethodRU

microsoft.dynamics365.finance.tax: TaxTypeBR

TaxTypeBR

microsoft.dynamics365.finance.tax: TaxTypeW

TaxTypeW

microsoft.dynamics365.finance.tax: TableGroupAll

"Table"|"GroupId"|"All"

TableGroupAll

microsoft.dynamics365.finance.tax: FiscalDocDirectionBR

"Incoming"|"Outgoing"

FiscalDocDirectionBR

microsoft.dynamics365.finance.tax: RTax25TaxModule

"Tax"|"RPayFund"|"Asset_RU"

RTax25TaxModule

microsoft.dynamics365.finance.tax: RestoredVATGainCalcMethodRU

"All"|"Indirect"

RestoredVATGainCalcMethodRU

microsoft.dynamics365.finance.tax: TaxSubstitutionEnumBR

"None"|"Markup"|"SimplifiedEstimate"|"MarkupConfaz_52_2017"

TaxSubstitutionEnumBR

microsoft.dynamics365.finance.tax: CustVendTypeBR

"Customer"|"Vendor"|"FiscalEstablishment"

CustVendTypeBR

microsoft.dynamics365.finance.tax: TaxFiscalValueBR

"Blank"|"WithCreditDebit"|"WithoutCreditDebitExempt"|"WithoutCreditDebitOther"

TaxFiscalValueBR

microsoft.dynamics365.finance.tax: TaxPrintDetail

"TaxCode"|"TaxGroup"|"NoDetail"

TaxPrintDetail

microsoft.dynamics365.finance.tax: PeriodUnit

"Day"|"Month"|"Year"|"All"

PeriodUnit

microsoft.dynamics365.finance.tax: NoYes

"No"|"Yes"

NoYes

microsoft.dynamics365.finance.tax: TaxCalculationDateType

"InvoiceDate"|"DeliveryDate"|"DocumentDate"

TaxCalculationDateType

microsoft.dynamics365.finance.tax: TaxTypeJP

"Standard"|"Reduced"|"Other"

TaxTypeJP

Import

import ballerinax/microsoft.dynamics365.finance.tax;

Other versions

0.8.0

Metadata

Released date: 2 days ago

Version: 0.8.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Name/Microsoft Dynamics 365 Finance Tax

Area/Tax

Vendor/Microsoft

Dynamics365

Finance

ERP

Type/Connector

Tax

VAT

GST

Taxation

Contributors

Dependencies

ballerina/data.jsondata/1.1.3 ballerina/url/2.6.1 ballerina/http/2.16.3

Cookie policy

Delete policy

clients

records

unionTypes

ballerinax/microsoft.dynamics365.finance.tax Ballerina library

Overview

Key Features

Setup guide

Prerequisites

Step 1: Register an application in Azure AD

Step 2: Grant Dynamics 365 API permissions

Step 3: Add the app as a D365 user

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Step 4: Run the Ballerina application

Examples

Clients

microsoft.dynamics365.finance.tax: Client

Constructor

listCFOPCodes

Parameters

Return Type

createCFOPCodes

Parameters

Return Type

getCFOPCodes

Parameters

Return Type

deleteCFOPCodes

Parameters

Return Type

updateCFOPCodes

Parameters

Return Type

listCFOPGroups

Parameters

Return Type

createCFOPGroups

Parameters

Return Type

getCFOPGroups

Parameters

Return Type

deleteCFOPGroups

Parameters

Return Type

updateCFOPGroups

Parameters

Return Type

listELParameters

Parameters

Return Type

createELParameters

Parameters

Return Type

getELParameters

Parameters

Return Type

deleteELParameters

Parameters

Return Type

updateELParameters

Parameters

Return Type

listGSTMinorCodes

Parameters

Return Type

createGSTMinorCodes

Parameters

Return Type

getGSTMinorCodes

Parameters

Return Type

deleteGSTMinorCodes

Parameters

Return Type

updateGSTMinorCodes

Parameters

Return Type