Taxes | IES Statement
Service to manage entities of type 'IESStatement'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements |
| 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:
- ApiIESStatementIESStatementLinesResource
- ApiIESStatementResource
- IESStatementLineResource
- IESStatementResource
- MoneyResource
All Enumerations
This service uses the following enumerations:
GET IESStatements
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See IESStatementResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements
GET /taxAuthorityPT/iESStatements
GET IESStatements (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 IESStatementResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements?page={page}&pageSize={pageSize}
GET /taxAuthorityPT/iESStatements?page={page}&pageSize={pageSize}
GET IESStatement 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 IESStatementResource. |
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}/taxAuthorityPT/iESStatements/{id}
GET /taxAuthorityPT/iESStatements/{id}
GET IESStatement by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
Response:
| When successful, the response body contains the entity record. See IESStatementResource. |
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}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}
GET /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}
GET Print IESStatement by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{id}/print?template={template}
GET /taxAuthorityPT/iESStatements/{id}/print?template={template}
GET Print IESStatement by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
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}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/print
GET /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/print
GET Original Print IESStatementOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{id}/printOriginal?template={template}
GET /taxAuthorityPT/iESStatements/{id}/printOriginal?template={template}
GET Original Print IESStatement by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
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}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/printOriginal
GET /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/printOriginal
POST IESStatements
Creates a new entity record.
The following elements are required:
| iESStatementResource | (ApiIESStatementResource) The request body should contain the entity record that should be created. See ApiIESStatementResource. |
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 ApiIESStatementResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements
POST /taxAuthorityPT/iESStatements
POST IES Statement
Inserts a new 'IES Statement Line' in the 'IES Statement'.
The following elements are required:
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
| companyKey | (string) The company key. |
| value | (ApiIESStatementIESStatementLinesResource) The ApiIESStatementIESStatementLinesResource instance. See ApiIESStatementIESStatementLinesResource. |
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}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/iESStatementLines
POST /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/iESStatementLines
PUT Set BalanceNote IESStatementLine
Updates the value of attribute 'BalanceNote' in the specified entity record.
The following elements are required:
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/iESStatementLines/{lineId}/balanceNote
PUT /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/iESStatementLines/{lineId}/balanceNote
PUT Set IsActive IESStatement
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| iESStatementKey | (string) The IES Statement 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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/isActive
PUT /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/isActive
PUT Set IsPrinted IESStatement
Updates the value of attribute 'IsPrinted' in the specified entity record.
The following elements are required:
| iESStatementKey | (string) The IES Statement 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. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/isPrinted
PUT /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/isPrinted
PUT Set PrintedReportName IESStatement
Updates the value of attribute 'PrintedReportName' in the specified entity record.
The following elements are required:
| iESStatementKey | (string) The IES Statement 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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/printedReportName
PUT /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/printedReportName
PUT Set Remarks IESStatement
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| iESStatementKey | (string) The IES Statement 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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/remarks
PUT /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/remarks
PUT Set Total IESStatement
Updates the value of attribute 'Total' in the specified entity record.
The following elements are required:
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
| companyKey | (string) The company key. |
| value | (decimal) 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}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/total
PUT /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/total
DELETE IES Statement Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
| companyKey | (string) The company 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}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/iESStatementLines/{lineId}
DELETE /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}/iESStatementLines/{lineId}
DELETE IESStatement 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}/taxAuthorityPT/iESStatements/{id}
DELETE /taxAuthorityPT/iESStatements/{id}
DELETE IESStatement by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| iESStatementKey | (string) The IES Statement 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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}
DELETE /taxAuthorityPT/iESStatements/{companyKey}/{iESStatementKey}
Resources
ApiIESStatementIESStatementLinesResource
The following elements are optional:
| balanceNote | (string) The balance note field. |
ApiIESStatementResource
The following elements are required:
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
| company | (string) The IES Statements company. The company code is the central organizational unit within the system. |
| financialYear | (string) The financial year of the IES Statement. (ex: 2020). |
| type | (enum ReportVersion) The declaration type. if is the first or subtitute declaration.
See ReportVersion. |
| attachmentA | (bool) If checked true the Attachment A is exported. |
| attachmentI | (bool) If checked true the Attachment I is exported. |
| attachmentL | (bool) If checked true the Attachment L is exported. |
| attachmentO | (bool) If checked true the Attachment O is exported. |
| attachmentP | (bool) If checked true the Attachment P is exported. |
| total | (MoneyResource) (internal).
See MoneyResource . |
The following elements are optional:
| startExplorationDate | (DateTime) The start exploration date to fill if the attachment R is checked. |
| remarks | (string) The corporate tax remarks. |
| iESStatementLines | (List of ApiIESStatementIESStatementLinesResource) IES Statement lines.
See ApiIESStatementIESStatementLinesResource. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
| isPrinted | (bool) Is Printed. |
IESStatementLineResource
The following elements are required:
| total | (MoneyResource) Total amount of the line.
See MoneyResource . |
| currency | (string) Currency of the line. |
| hasNote | (bool) (internal). |
The following elements are optional:
| sourceReport | (string) The source report. |
| reportField | (string) The report field. |
| reportFieldDescription | (string) The report description field. |
| type | (string) Type. |
| balanceNote | (string) The balance note field. |
IESStatementResource
The following elements are required:
| iESStatementKey | (string) The IES Statement key. By default, it is a sequential number. |
| company | (string) The IES Statements company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| financialYear | (string) The financial year of the IES Statement. (ex: 2020).
(fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service. |
| type | (enum ReportVersion) The declaration type. if is the first or subtitute declaration.
See ReportVersion. |
| attachmentA | (bool) If checked true the Attachment A is exported. |
| attachmentI | (bool) If checked true the Attachment I is exported. |
| attachmentL | (bool) If checked true the Attachment L is exported. |
| attachmentO | (bool) If checked true the Attachment O is exported. |
| attachmentP | (bool) If checked true the Attachment P is exported. |
| attachmentR | (bool) If checked true the Attachment R is exported. |
| total | (MoneyResource) (internal).
See MoneyResource . |
| currency | (string) The company of the tax report.(ex: €).
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
The following elements are optional:
| startExplorationDate | (DateTime) The start exploration date to fill if the attachment R is checked. |
| remarks | (string) The corporate tax remarks. |
| status | (enum TaxReportState) Status of the document.
See TaxReportState. |
| iESStatementLines | (List of IESStatementLineResource) IES Statement lines.
See IESStatementLineResource. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
| isPrinted | (bool) Is Printed. |
| isReprinted | (bool) Indicates if the document has been reprinted. Internally determined. |
| isSigned | (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined. |
MoneyResource
The following elements are required:
| amount | (decimal) The amount. |
The following elements are optional:
| baseAmount | (decimal) The base amount. |
| reportingAmount | (decimal) The reporting amount. |
| fractionDigits | (int) The fraction digits. |
| symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.