Taxes | SAF-T (CV)
Service to manage entities of type 'LegalDeclarationCV'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxes/legalDeclarationCVs |
| 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 LegalDeclarationCVs (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 LegalDeclarationCVResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET LegalDeclarationCV 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 LegalDeclarationCVResource. |
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 LegalDeclarationCV by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| legalDeclarationKey | (string) The legal declaration's key. By default, it is a sequential number. |
Response:
| When successful, the response body contains the entity record. See LegalDeclarationCVResource. |
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 LegalDeclarationCVs
Creates a new entity record.
The following elements are required:
| legalDeclarationCVResource | (ApiLegalDeclarationCVResource) The request body should contain the entity record that should be created. See ApiLegalDeclarationCVResource. |
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 ApiLegalDeclarationCVResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive LegalDeclarationCV
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| legalDeclarationKey | (string) The legal declaration's key. By default, it is a sequential number. |
| companyKey | (string) The company 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:
PUT Set Note LegalDeclarationCV
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
| legalDeclarationKey | (string) The legal declaration's key. By default, it is a sequential number. |
| companyKey | (string) The company 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 Remarks LegalDeclarationCV
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| legalDeclarationKey | (string) The legal declaration's key. By default, it is a sequential number. |
| companyKey | (string) The company 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:
DELETE LegalDeclarationCV 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 LegalDeclarationCV by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| legalDeclarationKey | (string) The legal declaration's key. By default, it is a sequential number. |
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
ApiLegalDeclarationCVResource
The following elements are required:
| legalDeclarationKey | (string) The legal declaration's key. By default, it is a sequential number. |
| documentDate | (DateTime) The document's date. |
| startDate | (DateTime) The legal declaration's initial date. Sets the date from which documents should be included on SAF-T. |
| endDate | (DateTime) The legal declaration's final date. Sets the date up to which documents should be included on SAF-T. |
| company | (string) Company. |
| auditFileVersion | (enum AuditFileVersionCV) The audit file's version. Indicates the SAF-T version used in the legal declaration.
See AuditFileVersionCV. |
| legalDeclarationType | (enum LegalDeclarationCVType) The legal declaration's purpose.
See LegalDeclarationCVType. |
| year | (int) Year. |
The following elements are optional:
| note | (string) The legal declaration's note. |
| remarks | (string) The legal declaration's remarks. |
LegalDeclarationCVResource
The following elements are required:
| legalDeclarationKey | (string) The legal declaration's key. By default, it is a sequential number. |
| documentDate | (DateTime) The document's date. |
| startDate | (DateTime) The legal declaration's initial date. Sets the date from which documents should be included on SAF-T. |
| endDate | (DateTime) The legal declaration's final date. Sets the date up to which documents should be included on SAF-T. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| status | (enum LegalDeclarationState) The legal declaration's status.
See LegalDeclarationState. |
| auditFileVersion | (enum AuditFileVersionCV) The audit file's version. Indicates the SAF-T version used in the legal declaration.
See AuditFileVersionCV. |
| legalDeclarationType | (enum LegalDeclarationCVType) The legal declaration's purpose.
See LegalDeclarationCVType. |
| year | (int) Year. |
The following elements are optional:
| note | (string) The legal declaration's note. |
| remarks | (string) The legal declaration's remarks. |