Financials | Tax Type Code Financial

The Tax Type Code Financial represents the posting category used in tax type codes.

This service extends TaxTypeCodes.

Overview

api/{tenantKey}/{orgKey}/financialCore/taxTypeCodeFinancials

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE TaxTypeCodeFinancial by identifier
- DELETE TaxTypeCodeFinancial by key

All Resources

This service uses the following resources:

ApiBaseTaxTypeCodeFinancialResource
ApiTaxTypeCodeFinancialResource
BaseTaxTypeCodeFinancialResource
TaxGLAccountResource
TaxTypeCodeFinancialResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

BaseValue
RateType
RoundingType
ScaleMethod
TaxType

GET Operations

GET TaxTypeCodeFinancials

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxTypeCodeFinancials/extension

GET /financialCore/taxTypeCodeFinancials/extension

GET TaxTypeCodeFinancials (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 TaxTypeCodeFinancialResource.

Response status codes:

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

Resource URL:

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

GET /financialCore/taxTypeCodeFinancials/extension?page={page}&pageSize={pageSize}

GET TaxTypeCodeFinancial 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 TaxTypeCodeFinancialResource.

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/taxTypeCodeFinancials/{id}/extension

GET /financialCore/taxTypeCodeFinancials/{id}/extension

GET TaxTypeCodeFinancial by key

Returns the entity record that matches the specified key.

The following elements are required:

taxCodeKey

(string) The tax's code key.

Response:

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

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/taxTypeCodeFinancials/{taxCodeKey}/extension

GET /financialCore/taxTypeCodeFinancials/{taxCodeKey}/extension

GET TaxTypeCodeFinancials (with TaxTypeCode)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxTypeCodeFinancials

GET /financialCore/taxTypeCodeFinancials

GET TaxTypeCodeFinancials (with TaxTypeCode) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

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 BaseTaxTypeCodeFinancialResource.

Response status codes:

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

Resource URL:

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

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

GET TaxTypeCodeFinancial (with TaxTypeCode) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id	(string) The record identifier.

Response:

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

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/taxTypeCodeFinancials/{id}

GET /financialCore/taxTypeCodeFinancials/{id}

GET TaxTypeCodeFinancial (with TaxTypeCode) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

The following elements are required:

taxCodeKey

(string) The tax's code key.

Response:

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

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/taxTypeCodeFinancials/{taxCodeKey}

GET /financialCore/taxTypeCodeFinancials/{taxCodeKey}

POST Operations

POST TaxTypeCodeFinancials

Creates a new entity record.

The following elements are required:

taxTypeCodeFinancialResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiTaxTypeCodeFinancialResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxTypeCodeFinancials/extension

POST /financialCore/taxTypeCodeFinancials/extension

POST TaxTypeCodeFinancials (with ApiBaseTaxTypeCodeFinancial)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

taxTypeCodeFinancialResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiBaseTaxTypeCodeFinancialResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxTypeCodeFinancials

POST /financialCore/taxTypeCodeFinancials

POST Get Tax GL Account

This operation gets the tax glaccount and the tax reverse charge gLAccount for a given tax type code, chart of accounts and fiscal memo reason.

The following elements are required:

taxTypeCodeKey	(string) The Tax Code Key.
chartOfAccountKey	(string) The Chart of Account Key.
fiscalMemoReasonKey	(string) The Fiscal Memo Reason Key.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/taxTypeCodeFinancials/getTaxGLAccount/{taxTypeCodeKey}/{chartOfAccountKey}

POST /financialCore/taxTypeCodeFinancials/getTaxGLAccount/{taxTypeCodeKey}/{chartOfAccountKey}

PUT Operations

PUT Set IsActive TaxTypeCodeFinancial

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodeFinancials/{taxCodeKey}/isActive

PUT /financialCore/taxTypeCodeFinancials/{taxCodeKey}/isActive

PUT Set PostingCategory TaxTypeCodeFinancial

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodeFinancials/{taxCodeKey}/postingCategory

PUT /financialCore/taxTypeCodeFinancials/{taxCodeKey}/postingCategory

PUT Set Custom Attribute TaxTypeCodeFinancial

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

taxCodeKey	(string) The tax's code key.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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/taxTypeCodeFinancials/{taxCodeKey}/{customAttributeName}

PUT /financialCore/taxTypeCodeFinancials/{taxCodeKey}/{customAttributeName}

DELETE Operations

DELETE TaxTypeCodeFinancial 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/taxTypeCodeFinancials/{id}

DELETE /financialCore/taxTypeCodeFinancials/{id}

DELETE TaxTypeCodeFinancial by key

Deletes the entity record that matches the specified key.

The following elements are required:

taxCodeKey

(string) The tax's code key.

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/taxTypeCodeFinancials/{taxCodeKey}

DELETE /financialCore/taxTypeCodeFinancials/{taxCodeKey}

Resources

ApiBaseTaxTypeCodeFinancialResource

The following elements are required:

postingCategory	(string) The posting category is used to decode the gl accounts based on the chart of account and fiscal memo reason.
taxCodeKey	(string) The tax's code key.
eUSalesList	(bool) Indicates if is a tax for EU.
roundingOff	(int) Indicates the number of decimal places.
scaleMethod	(enum ScaleMethod) Indicates the scale method. See ScaleMethod.
roundingType	(enum RoundingType) The type of rounding applicable on withholding tax. See RoundingType.
rateType	(enum RateType) Indicates the rate type. See RateType.
baseValue	(enum BaseValue) Indicates if the value is calculated based on net amount of document or per line. See BaseValue.
taxClass	(string) Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax.
taxSubClass	(string) The specific subcategory of a tax whose payment is required by the state.
taxRegionalArea	(string) The geographical area where certain tax rules and requirements are applied.
isExternallyManaged	(bool) A flag indicating if the tax type code is externally managed.
reverseCharge	(bool) When the reverse charge is applied the recipent of the goods or services makes the declartion of both their purchases (Input tax) and the supplier's sale (output VAT) in their VAT return.
taxType	(enum TaxType) Choose whether the tax is input (purchases) or output (sales). See TaxType.
isPartyRequired	(bool) Specify if it necessary to have a party.

The following elements are optional:

description	(string) The tax's type description.
printCodeText	(string) The code that will be used in printing.
externalId	(string) The external identifier.
externalVersion	(string) The external version.
isDeductible	(bool) Internal flag set if the tax type code is deductible.

ApiTaxTypeCodeFinancialResource

The following elements are required:

postingCategory	(string) The posting category is used to decode the gl accounts based on the chart of account and fiscal memo reason.
taxCodeKey	(string) The tax's code key.

BaseTaxTypeCodeFinancialResource

The following elements are required:

postingCategory	(string) The posting category is used to decode the gl accounts based on the chart of account and fiscal memo reason.
taxCodeKey	(string) The tax's code key.
eUSalesList	(bool) Indicates if is a tax for EU.
roundingOff	(int) Indicates the number of decimal places.
scaleMethod	(enum ScaleMethod) Indicates the scale method. See ScaleMethod.
roundingType	(enum RoundingType) The type of rounding applicable on withholding tax. See RoundingType.
rateType	(enum RateType) Indicates the rate type. See RateType.
baseValue	(enum BaseValue) Indicates if the value is calculated based on net amount of document or per line. See BaseValue.
taxClass	(string) Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax.
taxSubClass	(string) The specific subcategory of a tax whose payment is required by the state.
taxRegionalArea	(string) The geographical area where certain tax rules and requirements are applied.
isExternallyManaged	(bool) A flag indicating if the tax type code is externally managed.
reverseCharge	(bool) When the reverse charge is applied the recipent of the goods or services makes the declartion of both their purchases (Input tax) and the supplier's sale (output VAT) in their VAT return.
taxType	(enum TaxType) Choose whether the tax is input (purchases) or output (sales). See TaxType.
isPartyRequired	(bool) Specify if it necessary to have a party.

The following elements are optional:

description	(string) The tax's type description.
printCodeText	(string) The code that will be used in printing.
externalId	(string) The external identifier.
externalVersion	(string) The external version.
isDeductible	(bool) Internal flag set if the tax type code is deductible.

TaxGLAccountResource

The following elements are optional:

taxGLAccountId	(Guid) The Tax GLAccount Identifier.
taxGLAccountKey	(string) The Tax GLAccount Key.
taxGLAccountDescription	(string) The Tax GLAccount Description.
taxReverseChargeGLAccountId	(Guid) The Tax Reverse Charge GLAccount identifier.
taxReverseChargeGLAccountKey	(string) The Tax Reverse Charge GLAccount key.
taxReverseChargeGLAccountDescription	(string) The Tax Reverse Charge GLAccount description.

TaxTypeCodeFinancialResource

The following elements are required:

postingCategory	(string) The posting category is used to decode the gl accounts based on the chart of account and fiscal memo reason. (fk) Allowed value: the natural key of a record of type PostingCategory. These records are accessibly through the PostingCategories service.
taxCodeKey	(string) The tax's code key.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

BaseValue

1	NetAmountPerLine
2	NetAmountDocumentTotal

RateType

1

PercentageOfNetAmount

RoundingType

2	RoundUp
3	Downwards
1	Normal

ScaleMethod

1

WholeAmount

TaxType

1	InputTax
2	OutputTax