Financials | Wht Tax Type Account

The Withholding Tax Type Account represents the decoded gl accounts for the account posting of withholding taxes.

This service extends WithholdingTaxTypes.

Overview

api/{tenantKey}/{orgKey}/financialCore/whtTaxTypeAccounts

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiBaseWhtTaxTypeAccountResource
ApiBaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource
ApiWhtTaxTypeAccountResource
ApiWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource
BaseWhtTaxTypeAccountResource
BaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource
WhtTaxTypeAccountDetailResource
WhtTaxTypeAccountResource
WithholdingTaxCodeGLAccountResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET WhtTaxTypeAccounts

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

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

GET /financialCore/whtTaxTypeAccounts/extension

GET WhtTaxTypeAccounts (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 WhtTaxTypeAccountResource.

Response status codes:

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

Resource URL:

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

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

GET WhtTaxTypeAccount 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 WhtTaxTypeAccountResource.

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

GET /financialCore/whtTaxTypeAccounts/{id}/extension

GET WhtTaxTypeAccount by key

Returns the entity record that matches the specified key.

The following elements are required:

withholdingTaxTypeKey

(string) The withholding tax's type key.

Response:

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

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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/extension

GET /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/extension

GET WhtTaxTypeAccounts (with WithholdingTaxType)

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/whtTaxTypeAccounts

GET /financialCore/whtTaxTypeAccounts

GET WhtTaxTypeAccounts (with WithholdingTaxType) (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 BaseWhtTaxTypeAccountResource.

Response status codes:

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

Resource URL:

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

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

GET WhtTaxTypeAccount (with WithholdingTaxType) 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 BaseWhtTaxTypeAccountResource.

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

GET /financialCore/whtTaxTypeAccounts/{id}

GET WhtTaxTypeAccount (with WithholdingTaxType) 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:

withholdingTaxTypeKey

(string) The withholding tax's type key.

Response:

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

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/whtTaxTypeAccounts/{withholdingTaxTypeKey}

GET /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}

GET Get Withholding Tax Code GL Account

This operation gets the decoded gl accounts for the account posting of withholding taxes.

The following elements are required:

withholdingTaxCodeNaturalKey	(string) The Withholding Tax Code Key.
chartOfAccountsKey	(string) The Chart of Accounts Key.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/whtTaxTypeAccounts/getWithholdingTaxCodeGLAccount

GET /financialCore/whtTaxTypeAccounts/getWithholdingTaxCodeGLAccount

POST Operations

POST WhtTaxTypeAccounts

Creates a new entity record.

The following elements are required:

whtTaxTypeAccountResource

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

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

Response status codes:

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

Resource URL:

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

POST /financialCore/whtTaxTypeAccounts/extension

POST WhtTaxTypeAccounts (with ApiBaseWhtTaxTypeAccount)

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

The following elements are required:

whtTaxTypeAccountResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/whtTaxTypeAccounts

POST /financialCore/whtTaxTypeAccounts

POST Wht Tax Type Account

Inserts a new 'Wht Tax Type Account Detail' in the 'Wht Tax Type Account'.

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type key.
value	(ApiWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource) The ApiWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource instance. See ApiWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource.

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 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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails

POST /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails

PUT Operations

PUT Set ChartOfAccount WhtTaxTypeAccountDetail

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

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type key.
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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}/chartOfAccount

PUT /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}/chartOfAccount

PUT Set GlAccount WhtTaxTypeAccountDetail

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

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type key.
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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}/glAccount

PUT /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}/glAccount

PUT Set IsActive WhtTaxTypeAccount

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

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type 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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/isActive

PUT /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/isActive

PUT Set Custom Attribute WhtTaxTypeAccount

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

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type 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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/{customAttributeName}

PUT /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/{customAttributeName}

PUT Set Custom Attribute WhtTaxTypeAccountDetail

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

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type key.
lineId	(string) The detail identifier.
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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}/{customAttributeName}

PUT /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}/{customAttributeName}

DELETE Operations

DELETE Wht Tax Type Account Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type key.
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/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}

DELETE /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}/whtTaxTypeAccountDetails/{lineId}

DELETE WhtTaxTypeAccount 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/whtTaxTypeAccounts/{id}

DELETE /financialCore/whtTaxTypeAccounts/{id}

DELETE WhtTaxTypeAccount by key

Deletes the entity record that matches the specified key.

The following elements are required:

withholdingTaxTypeKey

(string) The withholding tax's type 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/whtTaxTypeAccounts/{withholdingTaxTypeKey}

DELETE /financialCore/whtTaxTypeAccounts/{withholdingTaxTypeKey}

Resources

ApiBaseWhtTaxTypeAccountResource

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type key.
taxOfficeParty	(string) The tax office party that collects the withholding tax.
baseIncludesDiscount	(bool) The Base Includes Discount Indicates if the tax includes discount.
country	(string) The country indicates where the withholding tax is applied.

The following elements are optional:

whtTaxTypeAccountDetails	(List of ApiBaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource) The withholding type account detail is used to decode the gl accounts based on the chart of account. See ApiBaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource.
description	(string) The tax deducted at the beginning of the payment flow in some countries, and paid to the tax authorities on behalf of the person / company subject to that tax.
fiscalWitholdingTaxType	(string) The Fiscal Withholding Tax Type Indicates the fiscal withholding tax type.

ApiBaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource

The following elements are required:

chartOfAccount	(string) The company chart of accounts.
glAccount	(string) The general ledger account of the withholding tax type account detail.

ApiWhtTaxTypeAccountResource

The following elements are required:

withholdingTaxTypeKey

(string) The withholding tax's type key.

The following elements are optional:

whtTaxTypeAccountDetails

(List of ApiWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource) The withholding type account detail is used to decode the gl accounts based on the chart of account.
See ApiWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource.

ApiWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource

The following elements are required:

chartOfAccount	(string) The company chart of accounts.
glAccount	(string) The general ledger account of the withholding tax type account detail.

BaseWhtTaxTypeAccountResource

The following elements are required:

withholdingTaxTypeKey	(string) The withholding tax's type key.
taxOfficeParty	(string) The tax office party that collects the withholding tax.
baseIncludesDiscount	(bool) The Base Includes Discount Indicates if the tax includes discount.
country	(string) The country indicates where the withholding tax is applied.

The following elements are optional:

whtTaxTypeAccountDetails	(List of BaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource) The withholding type account detail is used to decode the gl accounts based on the chart of account. See BaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource.
description	(string) The tax deducted at the beginning of the payment flow in some countries, and paid to the tax authorities on behalf of the person / company subject to that tax.
fiscalWitholdingTaxType	(string) The Fiscal Withholding Tax Type Indicates the fiscal withholding tax type.

BaseWhtTaxTypeAccountWhtTaxTypeAccountDetailsResource

The following elements are required:

chartOfAccount	(string) The company chart of accounts.
glAccount	(string) The general ledger account of the withholding tax type account detail.

WhtTaxTypeAccountDetailResource

The following elements are required:

chartOfAccount	(string) The company chart of accounts.
glAccount	(string) The general ledger account of the withholding tax type account detail.

WhtTaxTypeAccountResource

The following elements are required:

withholdingTaxTypeKey

(string) The withholding tax's type key.

The following elements are optional:

whtTaxTypeAccountDetails

(List of WhtTaxTypeAccountDetailResource) The withholding type account detail is used to decode the gl accounts based on the chart of account.
See WhtTaxTypeAccountDetailResource.

WithholdingTaxCodeGLAccountResource

The following elements are optional:

accountId	(Guid) The GL Account Identifier.
accountKey	(string) The GL Account Key.
accountDescription	(string) The GL Account description.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.