Financials | Tax Settlement Setup

The Tax Settlement Setups is used to manage tax settlement configuration like DPIVA or DPIVA-A40.

Overview

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups

URL	api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST TaxSettlementSetups
- POST Tax Settlement Setup
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiTaxSettlementSetupResource
ApiTaxSettlementSetupTaxSettlementSetupAccountsResource
TaxSettlementSetupAccountResource
TaxSettlementSetupResource

GET Operations

GET TaxSettlementSetups

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See TaxSettlementSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups

GET /financialCore/taxSettlementSetups

GET TaxSettlementSetups (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See TaxSettlementSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups?page={page}&pageSize={pageSize}

GET /financialCore/taxSettlementSetups?page={page}&pageSize={pageSize}

GET TaxSettlementSetup by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See TaxSettlementSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{id}

GET /financialCore/taxSettlementSetups/{id}

GET TaxSettlementSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.

Response:

When successful, the response body contains the entity record. See TaxSettlementSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}

GET /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}

GET Print TaxSettlementSetup by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{id}/print?template={template}

GET /financialCore/taxSettlementSetups/{id}/print?template={template}

GET Print TaxSettlementSetup by key

Prints the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/print

GET /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/print

GET Original Print TaxSettlementSetupOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{id}/printOriginal?template={template}

GET /financialCore/taxSettlementSetups/{id}/printOriginal?template={template}

GET Original Print TaxSettlementSetup by key

Prints the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/printOriginal

GET /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/printOriginal

GET Get Tax Settlement Setup By Id

This operation gets the Tax Settlement Setup given a chart of account and a tax class.

The following elements are required:

chartOfAccountId	(Guid) The Chart of Accounts identifier.
taxClassId	(Guid) The Tax Class Identifier.

Response:

When successful, the response body contains a resource of type 'TaxSettlementSetupResource'. See TaxSettlementSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/getTaxSettlementSetupById/{chartOfAccountId}/{taxClassId}

GET /financialCore/taxSettlementSetups/getTaxSettlementSetupById/{chartOfAccountId}/{taxClassId}

POST Operations

POST TaxSettlementSetups

Creates a new entity record.

The following elements are required:

taxSettlementSetupResource

(ApiTaxSettlementSetupResource) The request body should contain the entity record that should be created.
See ApiTaxSettlementSetupResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiTaxSettlementSetupResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups

POST /financialCore/taxSettlementSetups

POST Tax Settlement Setup

Inserts a new 'Tax Settlement Setup Account' in the 'Tax Settlement Setup'.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(ApiTaxSettlementSetupTaxSettlementSetupAccountsResource) The ApiTaxSettlementSetupTaxSettlementSetupAccountsResource instance. See ApiTaxSettlementSetupTaxSettlementSetupAccountsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts

POST /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts

PUT Operations

PUT Set ChartOfAccount TaxSettlementSetup

Updates the value of attribute 'ChartOfAccount' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/chartOfAccount

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/chartOfAccount

PUT Set ChartOfAccount TaxSettlementSetupAccount

Updates the value of attribute 'ChartOfAccount' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts/{lineId}/chartOfAccount

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts/{lineId}/chartOfAccount

PUT Set Description TaxSettlementSetup

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/description

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/description

PUT Set GLAccount TaxSettlementSetupAccount

Updates the value of attribute 'GLAccount' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts/{lineId}/gLAccount

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts/{lineId}/gLAccount

PUT Set IsActive TaxSettlementSetup

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/isActive

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/isActive

PUT Set TaxClass TaxSettlementSetup

Updates the value of attribute 'TaxClass' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxClass

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxClass

PUT Set TaxPayableAccount TaxSettlementSetup

Updates the value of attribute 'TaxPayableAccount' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxPayableAccount

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxPayableAccount

PUT Set TaxReceivableAccount TaxSettlementSetup

Updates the value of attribute 'TaxReceivableAccount' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxReceivableAccount

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxReceivableAccount

PUT Set TaxReimbursementAccount TaxSettlementSetup

Updates the value of attribute 'TaxReimbursementAccount' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxReimbursementAccount

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxReimbursementAccount

PUT Set TaxSettlementAccount TaxSettlementSetup

Updates the value of attribute 'TaxSettlementAccount' in the specified entity record.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementAccount

PUT /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementAccount

DELETE Operations

DELETE Tax Settlement Setup Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts/{lineId}

DELETE /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}/taxSettlementSetupAccounts/{lineId}

DELETE TaxSettlementSetup by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{id}

DELETE /financialCore/taxSettlementSetups/{id}

DELETE TaxSettlementSetup by key

Deletes the entity record that matches the specified key.

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}

DELETE /financialCore/taxSettlementSetups/{chartOfAccount}/{taxClass}

Resources

ApiTaxSettlementSetupResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
taxSettlementAccount	(string) The GL account that is used in the settlement process for settlement.
taxPayableAccount	(string) The GL account that is used in the settlement process for tax to pay.
taxReceivableAccount	(string) The GL account that is used in the settlement process for tax to receive.
taxReimbursementAccount	(string) The GL account that is used in the settlement process when the user selects the option to ask for reimbursement.

The following elements are optional:

taxSettlementSetupAccounts	(List of ApiTaxSettlementSetupTaxSettlementSetupAccountsResource) The tax settlement setup account lines. See ApiTaxSettlementSetupTaxSettlementSetupAccountsResource.
description	(string) The description of the tax settlement setup.

ApiTaxSettlementSetupTaxSettlementSetupAccountsResource

The following elements are required:

gLAccount	(string) The general ledger account of the tax settlement setup.
chartOfAccount	(string) The company chart of accounts.

TaxSettlementSetupAccountResource

The following elements are required:

gLAccount	(string) The general ledger account of the tax settlement setup.
chartOfAccount	(string) The company chart of accounts.

TaxSettlementSetupResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) The tax class.
taxSettlementAccount	(string) The GL account that is used in the settlement process for settlement.
taxPayableAccount	(string) The GL account that is used in the settlement process for tax to pay.
taxReceivableAccount	(string) The GL account that is used in the settlement process for tax to receive.
taxReimbursementAccount	(string) The GL account that is used in the settlement process when the user selects the option to ask for reimbursement.

The following elements are optional:

taxSettlementSetupAccounts	(List of TaxSettlementSetupAccountResource) The tax settlement setup account lines. See TaxSettlementSetupAccountResource.
description	(string) The description of the tax settlement setup.