Portuguese Payroll | Payroll Simulation

Service to manage entities of type 'PayrollSimulation'.

Overview

URL	api/{tenantKey}/{orgKey}/payrollPT/payrollSimulations
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET PayrollSimulations
  • GET PayrollSimulations (paged)
  • GET PayrollSimulation by identifier
  • GET PayrollSimulation by key
  • GET Print PayrollSimulation by identifier
  • GET Print PayrollSimulation by key
  • GET Original Print PayrollSimulationOriginal by identifier
  • GET Original Print PayrollSimulation by key
• POST:
  • POST PayrollSimulations
  • POST Payroll Simulation
  • POST Payroll Simulation
  • POST Payroll Simulation
  • POST Payroll Simulation
• PUT:
  • PUT Set IsActive PayrollSimulation
  • PUT Set PayrollSimulationKey PayrollSimulation
  • PUT Set HiringDate PayrollSimulation
  • PUT Set Description PayrollSimulation
  • PUT Set EarningModel PayrollSimulation
  • PUT Set DeductionModel PayrollSimulation
  • PUT Set FiscalState PayrollSimulation
  • PUT Set EarningType PayrollSimulation
  • PUT Set TaxResidence PayrollSimulation
  • PUT Set EarningHolders PayrollSimulation
  • PUT Set DisabilityDegreeHolder PayrollSimulation
  • PUT Set SecondHolderMajorEarning PayrollSimulation
  • PUT Set SecondHolderDisabilityDegree PayrollSimulation
  • PUT Set Dependants PayrollSimulation
  • PUT Set DisabilityDegreeDependents PayrollSimulation
  • PUT Set FixedTax PayrollSimulation
  • PUT Set TaxJurisdictionService PayrollSimulation
  • PUT Set TotalEarnings PayrollSimulation
  • PUT Set TotalDeductions PayrollSimulation
  • PUT Set TotalNetValue PayrollSimulation
  • PUT Set IsProcessing PayrollSimulation
  • PUT Set ProcessingConcluded PayrollSimulation
  • PUT Set Currency PayrollSimulation
  • PUT Set PrintedReportName PayrollSimulation
  • PUT Set IsPrinted PayrollSimulation
  • PUT Set IsReprinted PayrollSimulation
  • PUT Set IsSigned PayrollSimulation
  • PUT Set Company PayrollSimulation
  • PUT Set TotalCompanyCharges PayrollSimulation
  • PUT Set SimulationKind PayrollSimulation
  • PUT Set NetValue PayrollSimulation
  • PUT Set ShouldCreateContractDraft PayrollSimulation
  • PUT Set DisabilityFactor PayrollSimulation
  • PUT Set MortgageLoanWithholdingRegime PayrollSimulation
  • PUT Set Earning PayrollSimulationEarning
  • PUT Set Quantity PayrollSimulationEarning
  • PUT Set Value PayrollSimulationEarning
  • PUT Set Currency PayrollSimulationEarning
  • PUT Set NetValue PayrollSimulationEarning
  • PUT Set UnitValue PayrollSimulationEarning
  • PUT Set CompanyValue PayrollSimulationEarning
  • PUT Set Deduction PayrollSimulationDeduction
  • PUT Set EmployeeValue PayrollSimulationDeduction
  • PUT Set EmployeePercentage PayrollSimulationDeduction
  • PUT Set CompanyValue PayrollSimulationDeduction
  • PUT Set Currency PayrollSimulationDeduction
  • PUT Set Earning PayrollSimulationEarningInput
  • PUT Set InputQuantity PayrollSimulationEarningInput
  • PUT Set InputValue PayrollSimulationEarningInput
  • PUT Set Currency PayrollSimulationEarningInput
  • PUT Set Deduction PayrollSimulationDeductionInput
• DELETE:
  • DELETE Payroll Simulation Earning by identifier
  • DELETE Payroll Simulation Deduction by identifier
  • DELETE Payroll Simulation Earning Input by identifier
  • DELETE Payroll Simulation Deduction Input by identifier
  • DELETE PayrollSimulation by identifier
  • DELETE PayrollSimulation by key

All Resources

This service uses the following resources:

• ApiPayrollSimulationPayrollSimDeductionInputsResource
• ApiPayrollSimulationPayrollSimulationDeductionsResource
• ApiPayrollSimulationPayrollSimulationEarningInputsResource
• ApiPayrollSimulationPayrollSimulationEarningsResource
• ApiPayrollSimulationResource
• MoneyResource
• PayrollSimulationDeductionInputResource
• PayrollSimulationDeductionResource
• PayrollSimulationEarningInputResource
• PayrollSimulationEarningResource
• PayrollSimulationResource

All Enumerations

This service uses the following enumerations:

• EarningType
• FiscalState
• MortgageLoanWithholdingRegime
• SimulationKind
• TaxResidence

GET Operations

GET PayrollSimulations

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See PayrollSimulationResource.

Response status codes:

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

Resource URL:

GET PayrollSimulations (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 PayrollSimulationResource.

Response status codes:

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

Resource URL:

GET PayrollSimulation 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 PayrollSimulationResource.

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 PayrollSimulation by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
payrollSimulationKey	(string) Payroll Simulation.

Response:

When successful, the response body contains the entity record. See PayrollSimulationResource.

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 PayrollSimulation 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 PayrollSimulation by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
payrollSimulationKey	(string) Payroll Simulation.

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 PayrollSimulationOriginal 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 PayrollSimulation by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
payrollSimulationKey	(string) Payroll Simulation.

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 Operations

POST PayrollSimulations

Creates a new entity record.

The following elements are required:

payrollSimulationResource

(ApiPayrollSimulationResource) The request body should contain the entity record that should be created. See ApiPayrollSimulationResource.

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 ApiPayrollSimulationResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Payroll Simulation

Inserts a new 'Payroll Simulation Earning' in the 'Payroll Simulation'.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(ApiPayrollSimulationPayrollSimulationEarningsResource) The ApiPayrollSimulationPayrollSimulationEarningsResource instance. See ApiPayrollSimulationPayrollSimulationEarningsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Payroll Simulation

Inserts a new 'Payroll Simulation Deduction' in the 'Payroll Simulation'.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(ApiPayrollSimulationPayrollSimulationDeductionsResource) The ApiPayrollSimulationPayrollSimulationDeductionsResource instance. See ApiPayrollSimulationPayrollSimulationDeductionsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Payroll Simulation

Inserts a new 'Payroll Simulation Earning Input' in the 'Payroll Simulation'.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(ApiPayrollSimulationPayrollSimulationEarningInputsResource) The ApiPayrollSimulationPayrollSimulationEarningInputsResource instance. See ApiPayrollSimulationPayrollSimulationEarningInputsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Payroll Simulation

Inserts a new 'Payroll Simulation Deduction Input' in the 'Payroll Simulation'.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(ApiPayrollSimulationPayrollSimDeductionInputsResource) The ApiPayrollSimulationPayrollSimDeductionInputsResource instance. See ApiPayrollSimulationPayrollSimDeductionInputsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set Company PayrollSimulation

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set CompanyValue PayrollSimulationDeduction

Updates the value of attribute 'CompanyValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set CompanyValue PayrollSimulationEarning

Updates the value of attribute 'CompanyValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set Currency PayrollSimulation

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set Currency PayrollSimulationDeduction

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
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:

PUT Set Currency PayrollSimulationEarning

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
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:

PUT Set Currency PayrollSimulationEarningInput

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
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:

PUT Set Deduction PayrollSimulationDeduction

Updates the value of attribute 'Deduction' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
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:

PUT Set Deduction PayrollSimulationDeductionInput

Updates the value of attribute 'Deduction' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
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:

PUT Set DeductionModel PayrollSimulation

Updates the value of attribute 'DeductionModel' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set Dependants PayrollSimulation

Updates the value of attribute 'Dependants' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(int) 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:

PUT Set Description PayrollSimulation

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set DisabilityDegreeDependents PayrollSimulation

Updates the value of attribute 'DisabilityDegreeDependents' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(int) 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:

PUT Set DisabilityDegreeHolder PayrollSimulation

Updates the value of attribute 'DisabilityDegreeHolder' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set DisabilityFactor PayrollSimulation

Updates the value of attribute 'DisabilityFactor' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(int) 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:

PUT Set Earning PayrollSimulationEarning

Updates the value of attribute 'Earning' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
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:

PUT Set Earning PayrollSimulationEarningInput

Updates the value of attribute 'Earning' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
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:

PUT Set EarningHolders PayrollSimulation

Updates the value of attribute 'EarningHolders' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(int) 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:

PUT Set EarningModel PayrollSimulation

Updates the value of attribute 'EarningModel' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set EarningType PayrollSimulation

Updates the value of attribute 'EarningType' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(enum EarningType) The request body should contain the new value for the attribute. See EarningType.

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:

PUT Set EmployeePercentage PayrollSimulationDeduction

Updates the value of attribute 'EmployeePercentage' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set EmployeeValue PayrollSimulationDeduction

Updates the value of attribute 'EmployeeValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set FiscalState PayrollSimulation

Updates the value of attribute 'FiscalState' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(enum FiscalState) The request body should contain the new value for the attribute. See FiscalState.

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:

PUT Set FixedTax PayrollSimulation

Updates the value of attribute 'FixedTax' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set HiringDate PayrollSimulation

Updates the value of attribute 'HiringDate' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(DateTime) 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:

PUT Set InputQuantity PayrollSimulationEarningInput

Updates the value of attribute 'InputQuantity' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set InputValue PayrollSimulationEarningInput

Updates the value of attribute 'InputValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set IsActive PayrollSimulation

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set IsPrinted PayrollSimulation

Updates the value of attribute 'IsPrinted' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set IsProcessing PayrollSimulation

Updates the value of attribute 'IsProcessing' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set IsReprinted PayrollSimulation

Updates the value of attribute 'IsReprinted' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set IsSigned PayrollSimulation

Updates the value of attribute 'IsSigned' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set MortgageLoanWithholdingRegime PayrollSimulation

Updates the value of attribute 'MortgageLoanWithholdingRegime' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(enum MortgageLoanWithholdingRegime) The request body should contain the new value for the attribute. See MortgageLoanWithholdingRegime.

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:

PUT Set NetValue PayrollSimulation

Updates the value of attribute 'NetValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set NetValue PayrollSimulationEarning

Updates the value of attribute 'NetValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set PayrollSimulationKey PayrollSimulation

Updates the value of attribute 'PayrollSimulationKey' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set PrintedReportName PayrollSimulation

Updates the value of attribute 'PrintedReportName' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set ProcessingConcluded PayrollSimulation

Updates the value of attribute 'ProcessingConcluded' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set Quantity PayrollSimulationEarning

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set SecondHolderDisabilityDegree PayrollSimulation

Updates the value of attribute 'SecondHolderDisabilityDegree' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set SecondHolderMajorEarning PayrollSimulation

Updates the value of attribute 'SecondHolderMajorEarning' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set ShouldCreateContractDraft PayrollSimulation

Updates the value of attribute 'ShouldCreateContractDraft' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set SimulationKind PayrollSimulation

Updates the value of attribute 'SimulationKind' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(enum SimulationKind) The request body should contain the new value for the attribute. See SimulationKind.

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:

PUT Set TaxJurisdictionService PayrollSimulation

Updates the value of attribute 'TaxJurisdictionService' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
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:

PUT Set TaxResidence PayrollSimulation

Updates the value of attribute 'TaxResidence' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(enum TaxResidence) The request body should contain the new value for the attribute. See TaxResidence.

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:

PUT Set TotalCompanyCharges PayrollSimulation

Updates the value of attribute 'TotalCompanyCharges' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set TotalDeductions PayrollSimulation

Updates the value of attribute 'TotalDeductions' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set TotalEarnings PayrollSimulation

Updates the value of attribute 'TotalEarnings' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set TotalNetValue PayrollSimulation

Updates the value of attribute 'TotalNetValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set UnitValue PayrollSimulationEarning

Updates the value of attribute 'UnitValue' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

PUT Set Value PayrollSimulationEarning

Updates the value of attribute 'Value' in the specified entity record.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) 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:

DELETE Operations

DELETE Payroll Simulation Earning by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Payroll Simulation Deduction by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Payroll Simulation Earning Input by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Payroll Simulation Deduction Input by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE PayrollSimulation 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 PayrollSimulation by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
payrollSimulationKey	(string) Payroll Simulation.

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

ApiPayrollSimulationPayrollSimDeductionInputsResource

The following elements are required:

deduction

(string) Deduction.

ApiPayrollSimulationPayrollSimulationDeductionsResource

The following elements are required:

deduction	(string) Deduction.
employeeValue	(MoneyResource) Value. See MoneyResource .
companyValue	(MoneyResource) Company Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

employeePercentage

(decimal) Percentage.

ApiPayrollSimulationPayrollSimulationEarningInputsResource

The following elements are required:

earning	(string) Earning.
inputValue	(MoneyResource) Input Value - not persisted. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

inputQuantity

(decimal) Input Quantity - not persisted.

ApiPayrollSimulationPayrollSimulationEarningsResource

The following elements are required:

earning	(string) Earning.
value	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.
netValue	(MoneyResource) Net Value. See MoneyResource .
unitValue	(decimal) Unit Value.
companyValue	(MoneyResource) Company. See MoneyResource .

The following elements are optional:

quantity

(decimal) Quantity.

ApiPayrollSimulationResource

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
hiringDate	(DateTime) Hiring Date.
fiscalState	(enum FiscalState) Fiscal State. See FiscalState.
earningType	(enum EarningType) Earning Type. See EarningType.
taxResidence	(enum TaxResidence) Tax Residence. See TaxResidence.
earningHolders	(int) Earning Holders.
disabilityDegreeHolder	(bool) Disability degree >= 60%.
secondHolderMajorEarning	(bool) Sec. Holder Major Earning.
secondHolderDisabilityDegree	(bool) Sec. Holder disab. Degree >= 60%.
dependants	(int) Number of Dependants.
disabilityDegreeDependents	(int) Dependants w/ disab. Degree >= 60%.
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .
totalDeductions	(MoneyResource) Total Deductions. See MoneyResource .
totalNetValue	(MoneyResource) Total Net Value. See MoneyResource .
currency	(string) Currency.
company	(string) Company.
totalCompanyCharges	(MoneyResource) Total Company Charges. See MoneyResource .
simulationKind	(enum SimulationKind) Simulation Kind. See SimulationKind.
netValue	(MoneyResource) Net Value. See MoneyResource .
shouldCreateContractDraft	(bool) Create contract draft at finalize.

The following elements are optional:

description	(string) Description.
earningModel	(string) Earning Model.
deductionModel	(string) Deduction Model.
fixedTax	(decimal) Fixed Tax.
taxJurisdictionService	(string) Tax Jurisdiction Service.
payrollSimulationEarnings	(List of ApiPayrollSimulationPayrollSimulationEarningsResource) Payroll Simulation Earnings. See ApiPayrollSimulationPayrollSimulationEarningsResource.
payrollSimulationDeductions	(List of ApiPayrollSimulationPayrollSimulationDeductionsResource) Payroll Simulation Deductions. See ApiPayrollSimulationPayrollSimulationDeductionsResource.
isProcessing	(bool) Is Processing.
processingConcluded	(string) Processing Concluded.
printedReportName	(string) Printed Report Name.
isPrinted	(bool) Is Printed.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
payrollSimulationEarningInputs	(List of ApiPayrollSimulationPayrollSimulationEarningInputsResource) Payroll Simulation Earning Inputs. See ApiPayrollSimulationPayrollSimulationEarningInputsResource.
payrollSimDeductionInputs	(List of ApiPayrollSimulationPayrollSimDeductionInputsResource) Payroll Sim Deduction Inputs. See ApiPayrollSimulationPayrollSimDeductionInputsResource.
disabilityFactor	(int) Disability Factor.
mortgageLoanWithholdingRegime	(enum MortgageLoanWithholdingRegime) Housing Withholding Regime. See MortgageLoanWithholdingRegime.

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.

PayrollSimulationDeductionInputResource

The following elements are required:

deduction

(string) Deduction.

PayrollSimulationDeductionResource

The following elements are required:

deduction	(string) Deduction.
employeeValue	(MoneyResource) Value. See MoneyResource .
companyValue	(MoneyResource) Company Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

employeePercentage

(decimal) Percentage.

PayrollSimulationEarningInputResource

The following elements are required:

earning	(string) Earning.
inputValue	(MoneyResource) Input Value - not persisted. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

inputQuantity

(decimal) Input Quantity - not persisted.

PayrollSimulationEarningResource

The following elements are required:

earning	(string) Earning.
value	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.
netValue	(MoneyResource) Net Value. See MoneyResource .
unitValue	(decimal) Unit Value.
companyValue	(MoneyResource) Company. See MoneyResource .

The following elements are optional:

quantity

(decimal) Quantity.

PayrollSimulationResource

The following elements are required:

payrollSimulationKey	(string) Payroll Simulation.
hiringDate	(DateTime) Hiring Date.
fiscalState	(enum FiscalState) Fiscal State. See FiscalState.
earningType	(enum EarningType) Earning Type. See EarningType.
taxResidence	(enum TaxResidence) Tax Residence. See TaxResidence.
earningHolders	(int) Earning Holders.
disabilityDegreeHolder	(bool) Disability degree >= 60%.
secondHolderMajorEarning	(bool) Sec. Holder Major Earning.
secondHolderDisabilityDegree	(bool) Sec. Holder disab. Degree >= 60%.
dependants	(int) Number of Dependants.
disabilityDegreeDependents	(int) Dependants w/ disab. Degree >= 60%.
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .
totalDeductions	(MoneyResource) Total Deductions. See MoneyResource .
totalNetValue	(MoneyResource) Total Net Value. See MoneyResource .
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
totalCompanyCharges	(MoneyResource) Total Company Charges. See MoneyResource .
simulationKind	(enum SimulationKind) Simulation Kind. See SimulationKind.
netValue	(MoneyResource) Net Value. See MoneyResource .
shouldCreateContractDraft	(bool) Create contract draft at finalize.

The following elements are optional:

description	(string) Description.
earningModel	(string) Earning Model. (fk) Allowed value: the natural key of a record of type EarningModel. These records are accessibly through the EarningModels service.
deductionModel	(string) Deduction Model. (fk) Allowed value: the natural key of a record of type DeductionModel. These records are accessibly through the DeductionModels service.
fixedTax	(decimal) Fixed Tax.
taxJurisdictionService	(string) Tax Jurisdiction Service.
payrollSimulationEarnings	(List of PayrollSimulationEarningResource) Payroll Simulation Earnings. See PayrollSimulationEarningResource.
payrollSimulationDeductions	(List of PayrollSimulationDeductionResource) Payroll Simulation Deductions. See PayrollSimulationDeductionResource.
isProcessing	(bool) Is Processing.
processingConcluded	(string) Processing Concluded.
printedReportName	(string) Printed Report Name.
isPrinted	(bool) Is Printed.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
payrollSimulationEarningInputs	(List of PayrollSimulationEarningInputResource) Payroll Simulation Earning Inputs. See PayrollSimulationEarningInputResource.
payrollSimDeductionInputs	(List of PayrollSimulationDeductionInputResource) Payroll Sim Deduction Inputs. See PayrollSimulationDeductionInputResource.
disabilityFactor	(int) Disability Factor.
mortgageLoanWithholdingRegime	(enum MortgageLoanWithholdingRegime) Housing Withholding Regime. See MortgageLoanWithholdingRegime.

Enumerations

EarningType

1	PaidEmployment
2	Pensioner

FiscalState

1	MarriedOrLifePartners
2	Others

MortgageLoanWithholdingRegime

1	BankCredit
2	Rent

SimulationKind

1	IlliquidValue
2	NetValue

TaxResidence

1	PTC
2	PTA
3	PTM
4	Nonresident