Taxes | Tax Report
The Tax Reports is used to create Tax Reports based on tax report setups.
Overview
| URL | api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports |
| 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:
- ApiTaxReportGoodsImportLinesResource
- ApiTaxReportResource
- MoneyResource
- TaxReportGoodsImportLineResource
- TaxReportLiteResource
- TaxReportResource
All Enumerations
This service uses the following enumerations:
GET TaxReports
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See TaxReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports
GET /taxAuthorityPT/taxReports
GET TaxReports (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 TaxReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports?page={page}&pageSize={pageSize}
GET /taxAuthorityPT/taxReports?page={page}&pageSize={pageSize}
GET TaxReport 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 TaxReportResource. |
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/taxReports/{id}
GET /taxAuthorityPT/taxReports/{id}
GET TaxReport by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Tax Report's key. By default, it is a sequential number. |
Response:
| When successful, the response body contains the entity record. See TaxReportResource. |
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/taxReports/{companyKey}/{reportKey}
GET /taxAuthorityPT/taxReports/{companyKey}/{reportKey}
GET Print TaxReport 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/taxReports/{id}/print?template={template}
GET /taxAuthorityPT/taxReports/{id}/print?template={template}
GET Print TaxReport by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Tax Report's 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/taxReports/{companyKey}/{reportKey}/print
GET /taxAuthorityPT/taxReports/{companyKey}/{reportKey}/print
GET Original Print TaxReportOriginal 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/taxReports/{id}/printOriginal?template={template}
GET /taxAuthorityPT/taxReports/{id}/printOriginal?template={template}
GET Original Print TaxReport by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Tax Report's 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/taxReports/{companyKey}/{reportKey}/printOriginal
GET /taxAuthorityPT/taxReports/{companyKey}/{reportKey}/printOriginal
GET Get Tax Report By Keys
This operation gets the tax report for the given year, month and tax class (optional).
The following elements are required:
| company | (string) The company key. |
| year | (int) The year to which the information relates to. |
| month | (int) The month to which the information relates to (monthly reports from 1 to 12, quarterly reports allows 3, 6, 9 and 12). |
| taxClass | (string) The tax class of the tax report (ex: IVA). |
Response:
| When successful, the response body contains a resource of type 'TaxReportLiteResource'. See TaxReportLiteResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports/getTaxReportByKeys/{company}/{year}/{month}/{taxClass}
GET /taxAuthorityPT/taxReports/getTaxReportByKeys/{company}/{year}/{month}/{taxClass}
GET Get Tax Report By Company Tax Id
This operation gets the tax report for the given company tax id, year, month and tax class (optional).
The following elements are required:
| companyTaxId | (string) The company tax Id. |
| year | (int) The year to which the information relates to. |
| month | (int) The month to which the information relates to (monthly reports from 1 to 12, quarterly reports allows 3, 6, 9 and 12). |
| taxClass | (string) The tax class of the tax report (ex: IVA). |
Response:
| When successful, the response body contains a resource of type 'TaxReportLiteResource'. See TaxReportLiteResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports/getTaxReportByCompanyTaxId/{companyTaxId}/{year}/{month}
GET /taxAuthorityPT/taxReports/getTaxReportByCompanyTaxId/{companyTaxId}/{year}/{month}
POST TaxReports
Creates a new entity record.
The following elements are required:
| taxReportResource | (ApiTaxReportResource) The request body should contain the entity record that should be created. See ApiTaxReportResource. |
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 ApiTaxReportResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports
POST /taxAuthorityPT/taxReports
PUT Set IsActive TaxReport
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| reportKey | (string) The Tax Report'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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports/{companyKey}/{reportKey}/isActive
PUT /taxAuthorityPT/taxReports/{companyKey}/{reportKey}/isActive
PUT Set IsPrinted TaxReport
Updates the value of attribute 'IsPrinted' in the specified entity record.
The following elements are required:
| reportKey | (string) The Tax Report'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. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports/{companyKey}/{reportKey}/isPrinted
PUT /taxAuthorityPT/taxReports/{companyKey}/{reportKey}/isPrinted
PUT Set PrintedReportName TaxReport
Updates the value of attribute 'PrintedReportName' in the specified entity record.
The following elements are required:
| reportKey | (string) The Tax Report'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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports/{companyKey}/{reportKey}/printedReportName
PUT /taxAuthorityPT/taxReports/{companyKey}/{reportKey}/printedReportName
PUT Set Remarks TaxReport
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| reportKey | (string) The Tax Report'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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports/{companyKey}/{reportKey}/remarks
PUT /taxAuthorityPT/taxReports/{companyKey}/{reportKey}/remarks
DELETE TaxReport 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/taxReports/{id}
DELETE /taxAuthorityPT/taxReports/{id}
DELETE TaxReport by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Tax Report'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:
api/{tenantKey}/{orgKey}/taxAuthorityPT/taxReports/{companyKey}/{reportKey}
DELETE /taxAuthorityPT/taxReports/{companyKey}/{reportKey}
Resources
ApiTaxReportGoodsImportLinesResource
The following elements are required:
| taxRegionalArea | (string) The region where the tax is reported (ex: Continente, Madeira). |
| taxableAmount | (MoneyResource) The amount of goods import subject to tax.
See MoneyResource . |
| inputStandardTax | (MoneyResource) The amount of deductible input tax (standard).
See MoneyResource . |
| inputIntermediateTax | (MoneyResource) The amount of deductible input tax (intermediate).
See MoneyResource . |
| inputReducedTax | (MoneyResource) The amount of deductible input tax (reduced).
See MoneyResource . |
ApiTaxReportResource
The following elements are required:
| reportKey | (string) The Tax Report's key. By default, it is a sequential number. |
| company | (string) The legal declaration's company. The company code is the central organizational unit within the system. |
| year | (int) The year of the recapitulative report.(ex: 2020). |
| month | (int) The month of the tax report.(ex: January). |
| taxClass | (string) The tax class of the tax report.(ex: IVA). |
| withinDeadline | (bool) The within deadline. |
| currency | (string) The company of the tax report.(ex: €). |
The following elements are optional:
| remarks | (string) The tax report's remarks. |
| goodsImportLines | (List of ApiTaxReportGoodsImportLinesResource) Goods Import Lines.
See ApiTaxReportGoodsImportLinesResource. |
| reimbursementPeriod | (enum ReimbursementPeriod) The reimbursement period.
See ReimbursementPeriod. |
| isPrinted | (bool) Flag to know if it was printed. |
| printedReportName | (string) Indicates the report name used to print the document. 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.
TaxReportGoodsImportLineResource
The following elements are required:
| taxRegionalArea | (string) The region where the tax is reported (ex: Continente, Madeira). |
| taxableAmount | (MoneyResource) The amount of goods import subject to tax.
See MoneyResource . |
| totalOutputTax | (MoneyResource) The total amount of output tax paid to the public administration. In the particular case of goods imports, with reverse charge, this amount should be equal to the sum of all input taxes (standard, intermediate, reduced).
See MoneyResource . |
| inputStandardTax | (MoneyResource) The amount of deductible input tax (standard).
See MoneyResource . |
| inputIntermediateTax | (MoneyResource) The amount of deductible input tax (intermediate).
See MoneyResource . |
| inputReducedTax | (MoneyResource) The amount of deductible input tax (reduced).
See MoneyResource . |
| currency | (string) Currency of the line. |
TaxReportLiteResource
The following elements are required:
| company | (string) The legal declaration's company. The company code is the central organizational unit within the system. |
| currency | (string) The company of the tax report.(ex: €). |
| month | (int) The month of the tax report.(ex: January). |
| taxClass | (string) The tax class of the tax report.(ex: IVA). |
| withinDeadline | (bool) The within deadline. |
| year | (int) The year of the recapitulative report.(ex: 2020). |
The following elements are optional:
| reimbursementPeriod | (enum ReimbursementPeriod) The reimbursement period.
See ReimbursementPeriod. |
| remarks | (string) The tax report's remarks. |
| reportingPeriod | (enum ReportingPeriod) The reporting period of the tax report.(ex: monthly).
See ReportingPeriod. |
| status | (enum TaxReportState) Status of the document.
See TaxReportState. |
TaxReportResource
The following elements are required:
| reportKey | (string) The Tax Report's key. By default, it is a sequential number. |
| company | (string) The legal declaration's 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. |
| year | (int) The year of the recapitulative report.(ex: 2020). |
| month | (int) The month of the tax report.(ex: January). |
| taxClass | (string) The tax class of the tax report.(ex: IVA).
(fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service. |
| withinDeadline | (bool) The within deadline. |
| 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. |
| inputTax | (MoneyResource) Total amount of input tax.
See MoneyResource . |
| outPutTax | (MoneyResource) Total amount of output tax.
See MoneyResource . |
| payableTax | (MoneyResource) Payable amount of tax.
See MoneyResource . |
| claimedReceivableTax | (MoneyResource) The claimend receivable amount tax.
See MoneyResource . |
| reportedReceivableTax | (MoneyResource) The reported receivable amount tax.
See MoneyResource . |
| taxTotal | (MoneyResource) Total tax amount.
See MoneyResource . |
The following elements are optional:
| taxReportSetup | (string) The setup of the tax report.
(fk) Allowed value: the natural key of a record of type TaxReportSetup. These records are accessibly through the TaxReportSetups service. |
| remarks | (string) The tax report's remarks. |
| goodsImportLines | (List of TaxReportGoodsImportLineResource) Goods Import Lines.
See TaxReportGoodsImportLineResource. |
| status | (enum TaxReportState) Status of the document.
See TaxReportState. |
| reportingPeriod | (enum ReportingPeriod) The reporting period of the tax report.(ex: monthly).
See ReportingPeriod. |
| reimbursementPeriod | (enum ReimbursementPeriod) The reimbursement period.
See ReimbursementPeriod. |
| isPrinted | (bool) Flag to know if it was printed. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
| 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. |