Assets | Fiscal Classification
The Fiscal Classification represents an item Fiscal Type.
Overview
| URL | api/{tenantKey}/{orgKey}/assetsCore/fiscalClassifications |
| Methods Supported | GET |
All Operations
This service includes the following operations:
- GET:
All Resources
This service uses the following resources:
GET FiscalClassifications
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See FiscalClassificationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FiscalClassifications (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 FiscalClassificationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FiscalClassification 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 FiscalClassificationResource. |
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:
GET FiscalClassification by key
Returns the entity record that matches the specified key.
The following elements are required:
| fiscalClassificationKey | (string) The fiscal classification key. This will classify the assets from an asset class in terms of legal classification. |
| ordinance | (string) Ordinance. |
Response:
| When successful, the response body contains the entity record. See FiscalClassificationResource. |
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:
PUT Set Custom Attribute FiscalClassification
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| fiscalClassificationKey | (string) The fiscal classification key. This will classify the assets from an asset class in terms of legal classification. |
| ordinance | (string) Ordinance |
| 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:
Resources
FiscalClassificationResource
The following elements are required:
| fiscalClassificationKey | (string) The fiscal classification key. This will classify the assets from an asset class in terms of legal classification. |
| ordinance | (string) Ordinance.
(fk) Allowed value: the natural key of a record of type Ordinance. These records are accessibly through the Ordinances service. |
The following elements are optional:
| description | (string) The description of the fiscal class. |
| isRoot | (bool) Determins if it's a root classification. |