Taxes | GL Account Tax
The GL Account Taxes represents the taxes configuration associated to a GL Account.
This service extends GLAccounts.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/gLAccountTaxes |
| 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:
All Enumerations
This service uses the following enumerations:
GET GLAccountTaxes
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See GLAccountTaxResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/gLAccountTaxes/extension
GET /taxesCore/gLAccountTaxes/extension
GET GLAccountTaxes (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 GLAccountTaxResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/gLAccountTaxes/extension?page={page}&pageSize={pageSize}
GET /taxesCore/gLAccountTaxes/extension?page={page}&pageSize={pageSize}
GET GLAccountTax 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 GLAccountTaxResource. |
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}/taxesCore/gLAccountTaxes/{id}/extension
GET /taxesCore/gLAccountTaxes/{id}/extension
GET GLAccountTax by key
Returns the entity record that matches the specified key.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
Response:
| When successful, the response body contains the entity record. See GLAccountTaxResource. |
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}/taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}/extension
GET /taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}/extension
GET GLAccountTaxes (with GLAccount)
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 BaseGLAccountTaxResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/gLAccountTaxes
GET /taxesCore/gLAccountTaxes
GET GLAccountTaxes (with GLAccount) (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 BaseGLAccountTaxResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/gLAccountTaxes?page={page}&pageSize={pageSize}
GET /taxesCore/gLAccountTaxes?page={page}&pageSize={pageSize}
GET GLAccountTax (with GLAccount) 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 BaseGLAccountTaxResource. |
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}/taxesCore/gLAccountTaxes/{id}
GET /taxesCore/gLAccountTaxes/{id}
GET GLAccountTax (with GLAccount) 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:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
Response:
| When successful, the response body contains the entity record. See BaseGLAccountTaxResource. |
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}/taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}
GET /taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}
POST GLAccountTaxes
Creates a new entity record.
The following elements are required:
| gLAccountTaxResource | (ApiGLAccountTaxResource) The request body should contain the entity record that should be created. See ApiGLAccountTaxResource. |
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 ApiGLAccountTaxResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/gLAccountTaxes/extension
POST /taxesCore/gLAccountTaxes/extension
POST GLAccountTaxes (with ApiBaseGLAccountTax)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| gLAccountTaxResource | (ApiGLAccountTaxResource) The request body should contain the entity record that should be created. See ApiGLAccountTaxResource. |
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 ApiBaseGLAccountTaxResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/gLAccountTaxes
POST /taxesCore/gLAccountTaxes
PUT Set IsActive GLAccountTax
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| 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}/taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}/isActive
PUT /taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}/isActive
PUT Set TaxTypeCode GLAccountTax
Updates the value of attribute 'TaxTypeCode' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| 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}/taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}/taxTypeCode
PUT /taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}/taxTypeCode
DELETE GLAccountTax 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}/taxesCore/gLAccountTaxes/{id}
DELETE /taxesCore/gLAccountTaxes/{id}
DELETE GLAccountTax by key
Deletes the entity record that matches the specified key.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
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}/taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}
DELETE /taxesCore/gLAccountTaxes/{chartOfAccount}/{gLAccountKey}
Resources
ApiBaseGLAccountTaxResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| allowsManualPostings | (bool) Choose if the account can be used directly in the journal editor. |
| allowsOtherCurrencies | (bool) Defines if the account allows postings in other currencies than the defined in the currency field. |
| allowsTaxes | (bool) Defines if the user can select a tax code key when using the journal editor. |
| allowsPostingWithoutTaxes | (bool) Defines if the user can record a transaction without a tax code key associated with the account. |
| allowsOtherNature | (bool) Defines whether the GL Account allows postings with other nature than the default. Internally determined by the GL account definition. |
| allowsBalOtherNature | (bool) Defines if the account allows balances in other nature than the default. |
| classType | (string) Defines the position of the account in the balance sheet of profit and loss statement. |
The following elements are optional:
| taxTypeCode | (string) Tax Type. |
| description | (string) The description of the GL account. |
| currency | (string) Some accounts (like bank accounts) have a fixed currency. In this case select the default currency of the account. |
| accountingNature | (enum AccountingNature) Defines the default nature of the account (debit or credit).
See AccountingNature. |
| subAccountType | (enum SubAccountType) If the account is a reconciliation account of a subledger (eg. customer) select the sub ledger. In this case the subledger account is required.
See SubAccountType. |
| taxonomyClass | (string) The class of taxonomy to filter the taxonomy key. Defaulted from the chart of accounts. |
| taxonomy | (string) The taxonomy of the GL account. The taxonomy is required for movement accounts if the chart of accounts is assigned to a taxonomy class. |
| searchTerm | (string) Defines a nick name for the account for easy search. |
| isTaxonomyRequired | (bool) Used on UIRules. |
| reversalGLAccount | (string) An alternative GL account that will be used when journal reversal. |
| subclassType | (string) The subclass type is a complementary classification of the account type. This is used on dashboards. |
| dynamicValueList | (string) Dynamic Value. |
| isExternal | (bool) A non-persisted flag indicating if the GL Account is created by an external tool (e.g. SAF-T importer). |
| allowsWithholdingTax | (bool) Allows Withholding Tax. |
| obligationsType | (enum ObligationsType) Obligations Type.
See ObligationsType. |
| party | (string) Party. |
ApiGLAccountTaxResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
The following elements are optional:
| taxTypeCode | (string) Tax Type. |
BaseGLAccountTaxResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| allowsManualPostings | (bool) Choose if the account can be used directly in the journal editor. |
| allowsOtherCurrencies | (bool) Defines if the account allows postings in other currencies than the defined in the currency field. |
| allowsTaxes | (bool) Defines if the user can select a tax code key when using the journal editor. |
| allowsPostingWithoutTaxes | (bool) Defines if the user can record a transaction without a tax code key associated with the account. |
| allowsOtherNature | (bool) Defines whether the GL Account allows postings with other nature than the default. Internally determined by the GL account definition. |
| allowsBalOtherNature | (bool) Defines if the account allows balances in other nature than the default. |
| classType | (string) Defines the position of the account in the balance sheet of profit and loss statement. |
The following elements are optional:
| taxTypeCode | (string) Tax Type. |
| description | (string) The description of the GL account. |
| currency | (string) Some accounts (like bank accounts) have a fixed currency. In this case select the default currency of the account. |
| accountingNature | (enum AccountingNature) Defines the default nature of the account (debit or credit).
See AccountingNature. |
| subAccountType | (enum SubAccountType) If the account is a reconciliation account of a subledger (eg. customer) select the sub ledger. In this case the subledger account is required.
See SubAccountType. |
| taxonomyClass | (string) The class of taxonomy to filter the taxonomy key. Defaulted from the chart of accounts. |
| taxonomy | (string) The taxonomy of the GL account. The taxonomy is required for movement accounts if the chart of accounts is assigned to a taxonomy class. |
| searchTerm | (string) Defines a nick name for the account for easy search. |
| isTaxonomyRequired | (bool) Used on UIRules. |
| reversalGLAccount | (string) An alternative GL account that will be used when journal reversal. |
| subclassType | (string) The subclass type is a complementary classification of the account type. This is used on dashboards. |
| dynamicValueList | (string) Dynamic Value. |
| isExternal | (bool) A non-persisted flag indicating if the GL Account is created by an external tool (e.g. SAF-T importer). |
| allowsWithholdingTax | (bool) Allows Withholding Tax. |
| obligationsType | (enum ObligationsType) Obligations Type.
See ObligationsType. |
| party | (string) Party. |
GLAccountTaxResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service. |
| gLAccountKey | (string) The key of the GL account. |
The following elements are optional:
| taxTypeCode | (string) Tax Type.
(fk) Allowed value: the natural key of a record of type TaxTypeCode. These records are accessibly through the TaxTypeCodes service. |