Portuguese Payroll | Single Report
Service to manage entities of type 'SingleReport'.
Overview
| URL | api/{tenantKey}/{orgKey}/payrollPT/singleReports |
| Methods Supported | GET, POST, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET SingleReports
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See SingleReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET SingleReports (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 SingleReportResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET SingleReport 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 SingleReportResource. |
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 SingleReport by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| year | (int) Year. |
Response:
| When successful, the response body contains the entity record. See SingleReportResource. |
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 Print SingleReport 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:
GET Print SingleReport by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| year | (int) Year. |
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:
GET Original Print SingleReportOriginal 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:
GET Original Print SingleReport by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| year | (int) Year. |
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:
POST SingleReports
Creates a new entity record.
The following elements are required:
| singleReportResource | (ApiSingleReportResource) The request body should contain the entity record that should be created. See ApiSingleReportResource. |
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 ApiSingleReportResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE SingleReport 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 SingleReport by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| year | (int) Year. |
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
ApiSingleReportResource
The following elements are required:
| year | (int) Year. |
| singleReportState | (enum SingleReportState) State.
See SingleReportState. |
| issueDate | (DateTime) Issue Date. |
| referenceDate | (DateTime) Reference Date. |
| company | (string) Company. |
The following elements are optional:
| description | (string) Description. |
| financialYear | (string) Financial Year. |
SingleReportResource
The following elements are required:
| year | (int) Year. |
| singleReportState | (enum SingleReportState) State.
See SingleReportState. |
| issueDate | (DateTime) Issue Date. |
| referenceDate | (DateTime) Reference Date. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. |
The following elements are optional:
| description | (string) Description. |
| financialYear | (string) Financial Year.
(fk) Allowed value: the natural key of a record of type FinancialYear. |