Taxes | Recapitulative Report
The Recapitulative Report is used to create recapitulative report based on recapitulative report setups.
Overview
| URL | api/{tenantKey}/{orgKey}/taxAuthorityPT/recapitulativeReports |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET RecapitulativeReports
- GET RecapitulativeReports (paged)
- GET RecapitulativeReport by identifier
- GET RecapitulativeReport by key
- GET Print RecapitulativeReport by identifier
- GET Print RecapitulativeReport by key
- GET Original Print RecapitulativeReportOriginal by identifier
- GET Original Print RecapitulativeReport by key
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET RecapitulativeReports
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See RecapitulativeReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/recapitulativeReports
GET /taxAuthorityPT/recapitulativeReports
GET RecapitulativeReports (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 RecapitulativeReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/recapitulativeReports?page={page}&pageSize={pageSize}
GET /taxAuthorityPT/recapitulativeReports?page={page}&pageSize={pageSize}
GET RecapitulativeReport 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 RecapitulativeReportResource. |
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/recapitulativeReports/{id}
GET /taxAuthorityPT/recapitulativeReports/{id}
GET RecapitulativeReport by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Recapitulative Report's key. By default, it is a sequential number. |
Response:
| When successful, the response body contains the entity record. See RecapitulativeReportResource. |
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/recapitulativeReports/{companyKey}/{reportKey}
GET /taxAuthorityPT/recapitulativeReports/{companyKey}/{reportKey}
GET Print RecapitulativeReport 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/recapitulativeReports/{id}/print?template={template}
GET /taxAuthorityPT/recapitulativeReports/{id}/print?template={template}
GET Print RecapitulativeReport by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Recapitulative 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/recapitulativeReports/{companyKey}/{reportKey}/print
GET /taxAuthorityPT/recapitulativeReports/{companyKey}/{reportKey}/print
GET Original Print RecapitulativeReportOriginal 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/recapitulativeReports/{id}/printOriginal?template={template}
GET /taxAuthorityPT/recapitulativeReports/{id}/printOriginal?template={template}
GET Original Print RecapitulativeReport by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Recapitulative 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/recapitulativeReports/{companyKey}/{reportKey}/printOriginal
GET /taxAuthorityPT/recapitulativeReports/{companyKey}/{reportKey}/printOriginal
POST RecapitulativeReports
Creates a new entity record.
The following elements are required:
| recapitulativeReportResource | (ApiRecapitulativeReportResource) The request body should contain the entity record that should be created. See ApiRecapitulativeReportResource. |
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 ApiRecapitulativeReportResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxAuthorityPT/recapitulativeReports
POST /taxAuthorityPT/recapitulativeReports
PUT Set IsActive RecapitulativeReport
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| reportKey | (string) The Recapitulative 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/recapitulativeReports/{companyKey}/{reportKey}/isActive
PUT /taxAuthorityPT/recapitulativeReports/{companyKey}/{reportKey}/isActive
PUT Set Remarks RecapitulativeReport
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| reportKey | (string) The Recapitulative 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/recapitulativeReports/{companyKey}/{reportKey}/remarks
PUT /taxAuthorityPT/recapitulativeReports/{companyKey}/{reportKey}/remarks
DELETE RecapitulativeReport 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/recapitulativeReports/{id}
DELETE /taxAuthorityPT/recapitulativeReports/{id}
DELETE RecapitulativeReport by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| reportKey | (string) The Recapitulative 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/recapitulativeReports/{companyKey}/{reportKey}
DELETE /taxAuthorityPT/recapitulativeReports/{companyKey}/{reportKey}
Resources
ApiRecapitulativeReportResource
The following elements are required:
| reportKey | (string) The Recapitulative Report's key. By default, it is a sequential number. |
| company | (string) The company of the recapitulative report. |
| year | (int) The year of the recapitulative report.(ex: 2020). |
| month | (int) The month of the recapitulative report.(ex: January). |
| taxClass | (string) The tax class of the recapitulative report.(ex: IVA). |
| recapitulativeReportSetup | (string) The setup of the recapitulative report. |
| reportVersion | (enum ReportVersion) The version of the recapitulative report.
See ReportVersion. |
| currency | (string) The company of the recapitulative report.(ex: €). |
The following elements are optional:
| remarks | (string) The remark of the recapitulative report. |
RecapitulativeReportResource
The following elements are required:
| reportKey | (string) The Recapitulative Report's key. By default, it is a sequential number. |
| company | (string) The company of the recapitulative report.
(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 recapitulative report.(ex: January). |
| taxClass | (string) The tax class of the recapitulative report.(ex: IVA).
(fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service. |
| recapitulativeReportSetup | (string) The setup of the recapitulative report.
(fk) Allowed value: the natural key of a record of type RecapitulativeReportSetup. These records are accessibly through the RecapitulativeReportSetups service. |
| reportVersion | (enum ReportVersion) The version of the recapitulative report.
See ReportVersion. |
| currency | (string) The company of the recapitulative 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:
| reportingPeriod | (enum ReportingPeriod) The reporting period of the recapitulative report.(ex: monthly).
See ReportingPeriod. |
| status | (enum TaxReportState) The status of the recapitulative report.
See TaxReportState. |
| remarks | (string) The remark of the recapitulative report. |