Portuguese Payroll | Income Statement Picking
Overview
| URL | api/{tenantKey}/{orgKey}/payrollPT/incomeStatementsPickings |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Income Statement Picking
Returns the list of entity records that can be processed by the 'IncomeStatements' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| yearFilter | (int) Year. |
| contractKind | (ContractKind) The contract kind. |
The following elements are optional:
| employeeFilter | (string) Employee This is a query string parameter. |
| workLocationFilter | (string) Work Location This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See IncomeStatementPickingLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollPT/incomeStatementsPickings/{pageIndex}/{pageSize}?employeeFilter={employeeFilter}&workLocationFilter={workLocationFilter}&company={company}
GET /payrollPT/incomeStatementsPickings/{pageIndex}/{pageSize}?employeeFilter={employeeFilter}&workLocationFilter={workLocationFilter}&company={company}
POST Income Statement Picking
Instructs the 'IncomeStatements' service to process the specified entity records.
The following elements are required:
| list | (IncomeStatementPickingLine) List of the entity records that should be processed. See IncomeStatementPickingLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollPT/incomeStatementsPickings/{companyKey}
POST /payrollPT/incomeStatementsPickings/{companyKey}
Resources
IncomeStatementPicking
The following elements are required:
| yearFilter | (int) Year. |
| contractKind | (enum ContractKind) The contract kind.
See ContractKind. |
| selectedCount | (int) Selected Count. |
The following elements are optional:
| employeeFilter | (string) Employee. |
| workLocationFilter | (string) Work Location. |
| company | (string) Company. |
IncomeStatementPickingLine
The following elements are required:
| selected | (bool) Selected. |
| employeeKey | (string) Employee Key. |
The following elements are optional:
| employee | (string) Employee. |
| workLocation | (string) Work Location. |
| company | (string) Company. |