Taxes | Fiscal Document Type
Service to manage entities of type 'FiscalDocumentType'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/fiscalDocumentTypes |
| 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 FiscalDocumentTypes (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See FiscalDocumentTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET FiscalDocumentType 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 FiscalDocumentTypeResource. |
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 FiscalDocumentType by key
Returns the entity record that matches the specified key.
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document's type key. |
Response:
| When successful, the response body contains the entity record. See FiscalDocumentTypeResource. |
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:
POST FiscalDocumentTypes
Creates a new entity record.
The following elements are required:
| fiscalDocumentTypeResource | (ApiFiscalDocumentTypeResource) The request body should contain the entity record that should be created. See ApiFiscalDocumentTypeResource. |
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 ApiFiscalDocumentTypeResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description FiscalDocumentType
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document's type 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:
PUT Set FiscalDocumentTypeKey FiscalDocumentType
Updates the value of attribute 'FiscalDocumentTypeKey' in the specified entity record.
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document's type 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:
PUT Set FiscalUse FiscalDocumentType
Updates the value of attribute 'FiscalUse' in the specified entity record.
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document's type key. |
| value | (enum FiscalUse) The request body should contain the new value for the attribute. See FiscalUse. |
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:
PUT Set IsActive FiscalDocumentType
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document'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:
DELETE FiscalDocumentType 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:
DELETE FiscalDocumentType by key
Deletes the entity record that matches the specified key.
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document'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:
Resources
ApiFiscalDocumentTypeResource
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document's type key. |
| fiscalUse | (enum FiscalUse) The fiscal use. Indicates if the fiscal document is a financial, stock or other type of document.
See FiscalUse. |
The following elements are optional:
| description | (string) The fiscal document's type description. Indicates the type of fiscal document. |
FiscalDocumentTypeResource
The following elements are required:
| fiscalDocumentTypeKey | (string) The fiscal document's type key. |
| fiscalUse | (enum FiscalUse) The fiscal use. Indicates if the fiscal document is a financial, stock or other type of document.
See FiscalUse. |
The following elements are optional:
| description | (string) The fiscal document's type description. Indicates the type of fiscal document. |