Portuguese Payroll | Income Statements Send

Overview

URL	api/{tenantKey}/{orgKey}/payrollPT/incomeStatementsSends
Methods Supported	GET, POST

All Operations

This service includes the following operations:

• GET:
  • GET Income Statements Send
• POST:
  • POST Income Statements Send

All Resources

This service uses the following resources:

• IncomeStatementSend
• IncomeStatementSendLine

GET Operations

GET Income Statements Send

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.

Response:

When successful, the response body contains the list of entity records available for processing. See IncomeStatementSendLine.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Operations

POST Income Statements Send

Instructs the 'IncomeStatements' service to process the specified entity records.

The following elements are required:

list	(IncomeStatementSendLine) List of the entity records that should be processed. See IncomeStatementSendLine.
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:

Resources

IncomeStatementSend

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.

IncomeStatementSendLine

The following elements are required:

selected

(bool) Selected.

The following elements are optional:

employee	(string) Employee.
incomeStatement	(string) Income Statement.
company	(string) Company.