Payroll | Processing

Service to manage entities of type 'Processing'.

Overview

URL	api/{tenantKey}/{orgKey}/payrollCore/processings
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Processings
  • GET Processings (paged)
  • GET Processing by identifier
  • GET Processing by key
  • GET Print Processing by identifier
  • GET Print Processing by key
  • GET Original Print ProcessingOriginal by identifier
  • GET Original Print Processing by key
  • GET Get Processings By Payment
  • GET Get Last Closed Processing By Company
  • GET Get Processings By Period
• POST:
  • POST Processings
  • POST Processing
  • POST Processing
  • POST Processing
  • POST Processing
  • POST Processing
  • POST Process Contracts
  • POST Close Processings
  • POST Process Contract
  • POST Process Contract Id
• PUT:
  • PUT Set IsActive Processing
  • PUT Set ProcessingKey Processing
  • PUT Set Contract Processing
  • PUT Set Employee Processing
  • PUT Set PeriodYear Processing
  • PUT Set PeriodMonth Processing
  • PUT Set Date Processing
  • PUT Set StartDate Processing
  • PUT Set EndDate Processing
  • PUT Set Number Processing
  • PUT Set Type Processing
  • PUT Set Company Processing
  • PUT Set Currency Processing
  • PUT Set HourlyWage Processing
  • PUT Set HourlyWageFormula Processing
  • PUT Set GrossBaseAllowance Processing
  • PUT Set IlliquidBaseAllowance Processing
  • PUT Set CalendarDaysCount Processing
  • PUT Set WorkedCalendarDaysCount Processing
  • PUT Set AbsentCalendarDayCount Processing
  • PUT Set WorkDaysCount Processing
  • PUT Set WorkDaysFullPeriodCount Processing
  • PUT Set WorkHoursCount Processing
  • PUT Set WorkHoursFullPeriodCount Processing
  • PUT Set WorkedWorkDaysCount Processing
  • PUT Set WorkedWorkHoursCount Processing
  • PUT Set Worked30DaysMonthCount Processing
  • PUT Set Absent30DaysMonthCount Processing
  • PUT Set VacationDaysCount Processing
  • PUT Set NextVacationDayCount Processing
  • PUT Set YearPeriodCount Processing
  • PUT Set MajVacationPeriod Processing
  • PUT Set LastPeriod Processing
  • PUT Set TotalEarnings Processing
  • PUT Set TotalEmployeeDeductions Processing
  • PUT Set TotalCompanyDeductions Processing
  • PUT Set NetValue Processing
  • PUT Set IsClosed Processing
  • PUT Set HourlyWageInfo Processing
  • PUT Set Worked30DaysMonthCountInfo Processing
  • PUT Set Absent30DaysMonthCountInfo Processing
  • PUT Set EstimatedEndDate Processing
  • PUT Set IncludeCessation Processing
  • PUT Set PaymentPeriod Processing
  • PUT Set PaidDaysCount Processing
  • PUT Set PaidHoursCount Processing
  • PUT Set AbsentUnjustifiedDaysCount Processing
  • PUT Set AbsentUnjustifiedHoursCount Processing
  • PUT Set PaidDays30DaysMonthCount Processing
  • PUT Set AbsentUnjustifedDays30DaysMonthCount Processing
  • PUT Set VacationDaysCountUsed Processing
  • PUT Set NextVacationDayCountUsed Processing
  • PUT Set MajVacationPeriodUsed Processing
  • PUT Set IsUser Processing
  • PUT Set WeekHoursCount Processing
  • PUT Set CompanyWeekHoursCount Processing
  • PUT Set IsTimeSheetCompleted Processing
  • PUT Set Department Processing
  • PUT Set Date ProcessingTimeSheet
  • PUT Set Expected ProcessingTimeSheet
  • PUT Set Efective ProcessingTimeSheet
  • PUT Set Absence ProcessingTimeSheet
  • PUT Set Paid ProcessingTimeSheet
  • PUT Set Unjustified ProcessingTimeSheet
  • PUT Set AbsenceType ProcessingAbsence
  • PUT Set StartDate ProcessingAbsence
  • PUT Set EndDate ProcessingAbsence
  • PUT Set Duration ProcessingAbsence
  • PUT Set AbsentCalendarDays ProcessingAbsence
  • PUT Set AbsentWorkDays ProcessingAbsence
  • PUT Set AbsentWorkHours ProcessingAbsence
  • PUT Set Unit ProcessingAbsence
  • PUT Set AbsenceId ProcessingAbsence
  • PUT Set Percentage ProcessingAbsence
  • PUT Set SourceType ProcessingEarning
  • PUT Set SourceId ProcessingEarning
  • PUT Set Earning ProcessingEarning
  • PUT Set Name ProcessingEarning
  • PUT Set EarningNature ProcessingEarning
  • PUT Set Aggregation ProcessingEarning
  • PUT Set Quantity ProcessingEarning
  • PUT Set UnitValue ProcessingEarning
  • PUT Set Value ProcessingEarning
  • PUT Set Currency ProcessingEarning
  • PUT Set Info ProcessingEarning
  • PUT Set NetValue ProcessingEarning
  • PUT Set GrossValue ProcessingEarning
  • PUT Set ReferenceDate ProcessingEarning
  • PUT Set Deduction ProcessingDeduction
  • PUT Set SourceId ProcessingDeduction
  • PUT Set Name ProcessingDeduction
  • PUT Set Aggregation ProcessingDeduction
  • PUT Set SubjectValue ProcessingDeduction
  • PUT Set ExemptValue ProcessingDeduction
  • PUT Set FreeValue ProcessingDeduction
  • PUT Set BracketValue ProcessingDeduction
  • PUT Set EmployeePercentage ProcessingDeduction
  • PUT Set EmployeeValue ProcessingDeduction
  • PUT Set CompanyPercentage ProcessingDeduction
  • PUT Set CompanyValue ProcessingDeduction
  • PUT Set Currency ProcessingDeduction
  • PUT Set Info ProcessingDeduction
  • PUT Set ModifiedDate ProcessingRetroactive
  • PUT Set Source ProcessingRetroactive
  • PUT Set User ProcessingRetroactive
• DELETE:
  • DELETE Processing Time Sheet by identifier
  • DELETE Processing Absence by identifier
  • DELETE Processing Earning by identifier
  • DELETE Processing Deduction by identifier
  • DELETE Processing Retroactive by identifier
  • DELETE Processing by identifier
  • DELETE Processing by key

All Resources

This service uses the following resources:

• ApiProcessingProcessingAbsencesResource
• ApiProcessingProcessingDeductionsProcDedByEarnNaturesResource
• ApiProcessingProcessingDeductionsResource
• ApiProcessingProcessingEarningsProcDeductionsByEarningsResource
• ApiProcessingProcessingEarningsResource
• ApiProcessingProcessingRetroactivesResource
• ApiProcessingProcessingTimeSheetsResource
• ApiProcessingResource
• MoneyResource
• ProcDeductionsByEarningNatureResource
• ProcDeductionsByEarningResource
• ProcessingAbsenceResource
• ProcessingDeductionResource
• ProcessingEarningResource
• ProcessingMainProcessingDeductionsResource
• ProcessingMainProcessingEarningsResource
• ProcessingMainResource
• ProcessingResource
• ProcessingRetroactiveResource
• ProcessingTimeSheetResource

All Enumerations

This service uses the following enumerations:

• HourlyWageFormula
• ProcessingEarningSourceType
• ProcessingRequestSourceType
• ProcessingType
• Unit

GET Operations

GET Processings

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET Processings (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 ProcessingResource.

Response status codes:

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

Resource URL:

GET Processing 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 ProcessingResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
processingKey	(string) Processing.

Response:

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

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

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
processingKey	(string) Processing.

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 ProcessingOriginal 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 Processing by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
processingKey	(string) Processing.

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 Get Processings By Payment

Get processings list in payment.

The following elements are required:

processingIDs

(IEnumerable) processingIDs.

Response:

When successful, the response body contains a list of resources of type 'ProcessingResource'. See ProcessingResource.

Response status codes:

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

Resource URL:

GET Get Last Closed Processing By Company

Returns the End Date of the last regular closed processing for specific company.

The following elements are required:

companyId

(Guid) The Company identifier.

Response:

When successful, the response body contains an item of type 'date'.

Response status codes:

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

Resource URL:

GET Get Processings By Period

Custom operation 'GetProcessingsByPeriod'.

The following elements are required:

period

(DateTime?) period.

Response:

When successful, the response body contains a list of resources of type 'ProcessingResource'. See ProcessingResource.

Response status codes:

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

Resource URL:

POST Operations

POST Processings

Creates a new entity record.

The following elements are required:

processingResource

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

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

Response status codes:

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

Resource URL:

POST Processing

Inserts a new 'Processing Time Sheet' in the 'Processing'.

The following elements are required:

processingKey	(string) Processing.
companyKey	(string) The company key.
value	(ApiProcessingProcessingTimeSheetsResource) The ApiProcessingProcessingTimeSheetsResource instance. See ApiProcessingProcessingTimeSheetsResource.

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 Processing

Inserts a new 'Processing Absence' in the 'Processing'.

The following elements are required:

processingKey	(string) Processing.
companyKey	(string) The company key.
value	(ApiProcessingProcessingAbsencesResource) The ApiProcessingProcessingAbsencesResource instance. See ApiProcessingProcessingAbsencesResource.

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 Processing

Inserts a new 'Processing Earning' in the 'Processing'.

The following elements are required:

processingKey	(string) Processing.
companyKey	(string) The company key.
value	(ApiProcessingProcessingEarningsResource) The ApiProcessingProcessingEarningsResource instance. See ApiProcessingProcessingEarningsResource.

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 Processing

Inserts a new 'Processing Deduction' in the 'Processing'.

The following elements are required:

processingKey	(string) Processing.
companyKey	(string) The company key.
value	(ApiProcessingProcessingDeductionsResource) The ApiProcessingProcessingDeductionsResource instance. See ApiProcessingProcessingDeductionsResource.

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 Processing

Inserts a new 'Processing Retroactive' in the 'Processing'.

The following elements are required:

processingKey	(string) Processing.
companyKey	(string) The company key.
value	(ApiProcessingProcessingRetroactivesResource) The ApiProcessingProcessingRetroactivesResource instance. See ApiProcessingProcessingRetroactivesResource.

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 Process Contracts

Send Async Task to processes all available contracts for specific company.

The following elements are required:

companyId

(Guid) CompanyId.

Response:

When successful, the response body is empty.

Resource URL:

POST Close Processings

Close or Open a list of processings.

The following elements are required:

processings	(IEnumerable) The list of processing Ids.
isClosed	(bool) Indicates wether the processing will be closed.
paymentPeriod	(DateTime?) PaymentPeriod.

Response:

When successful, the response body is empty.

Resource URL:

POST Process Contract

Processes a specifiedContrat.

The following elements are required:

contractKey	(string) Contract Key.
companyKey	(string) CompanyKey.

Response:

When successful, the response body is empty.

Resource URL:

POST Process Contract Id

Custom operation 'ProcessContractId'.

The following elements are required:

id	(Guid) Id.

Response:

When successful, the response body is empty.

Resource URL:

PUT Operations

PUT Set Absence ProcessingTimeSheet

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

The following elements are required:

processingKey	(string) Processing.
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 AbsenceId ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) 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 AbsenceType ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
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 Absent30DaysMonthCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Absent30DaysMonthCountInfo Processing

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

The following elements are required:

processingKey	(string) Processing.
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 AbsentCalendarDayCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 AbsentCalendarDays ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
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 AbsentUnjustifedDays30DaysMonthCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 AbsentUnjustifiedDaysCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 AbsentUnjustifiedHoursCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 AbsentWorkDays ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
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 AbsentWorkHours ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
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 Aggregation ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 Aggregation ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 BracketValue ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 CalendarDaysCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Company Processing

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

The following elements are required:

processingKey	(string) Processing.
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 CompanyPercentage ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 CompanyWeekHoursCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Contract Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Processing

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

The following elements are required:

processingKey	(string) Processing.
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 ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 Date Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Date ProcessingTimeSheet

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
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 Deduction ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 Department Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Duration ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
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 Earning ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 EarningNature ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 Efective ProcessingTimeSheet

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

The following elements are required:

processingKey	(string) Processing.
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 Employee Processing

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

The following elements are required:

processingKey	(string) Processing.
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 EmployeePercentage ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 EndDate Processing

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

The following elements are required:

processingKey	(string) Processing.
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 EndDate ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
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 EstimatedEndDate Processing

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

The following elements are required:

processingKey	(string) Processing.
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 ExemptValue ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 Expected ProcessingTimeSheet

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

The following elements are required:

processingKey	(string) Processing.
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 FreeValue ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 GrossBaseAllowance Processing

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

The following elements are required:

processingKey	(string) Processing.
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 GrossValue ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 HourlyWage Processing

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

The following elements are required:

processingKey	(string) Processing.
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 HourlyWageFormula Processing

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

The following elements are required:

processingKey	(string) Processing.
companyKey	(string) The company key.
value	(enum HourlyWageFormula) The request body should contain the new value for the attribute. See HourlyWageFormula.

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 HourlyWageInfo Processing

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

The following elements are required:

processingKey	(string) Processing.
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 IlliquidBaseAllowance Processing

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

The following elements are required:

processingKey	(string) Processing.
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 IncludeCessation Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Info ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 Info ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 IsActive Processing

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

The following elements are required:

processingKey	(string) Processing.
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 IsClosed Processing

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

The following elements are required:

processingKey	(string) Processing.
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 IsTimeSheetCompleted Processing

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

The following elements are required:

processingKey	(string) Processing.
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 IsUser Processing

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

The following elements are required:

processingKey	(string) Processing.
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 LastPeriod Processing

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

The following elements are required:

processingKey	(string) Processing.
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 MajVacationPeriod Processing

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

The following elements are required:

processingKey	(string) Processing.
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 MajVacationPeriodUsed Processing

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

The following elements are required:

processingKey	(string) Processing.
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 ModifiedDate ProcessingRetroactive

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(DateTimeOffset) 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 Name ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 Name ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 NetValue Processing

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

The following elements are required:

processingKey	(string) Processing.
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 ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 NextVacationDayCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 NextVacationDayCountUsed Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Number Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Paid ProcessingTimeSheet

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

The following elements are required:

processingKey	(string) Processing.
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 PaidDays30DaysMonthCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 PaidDaysCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 PaidHoursCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 PaymentPeriod Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Percentage ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
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 PeriodMonth Processing

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

The following elements are required:

processingKey	(string) Processing.
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 PeriodYear Processing

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

The following elements are required:

processingKey	(string) Processing.
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 ProcessingKey Processing

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

The following elements are required:

processingKey	(string) Processing.
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 ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 ReferenceDate ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
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 Source ProcessingRetroactive

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum ProcessingRequestSourceType) The request body should contain the new value for the attribute. See ProcessingRequestSourceType.

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 SourceId ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) 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 SourceId ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) 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 SourceType ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum ProcessingEarningSourceType) The request body should contain the new value for the attribute. See ProcessingEarningSourceType.

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 StartDate Processing

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

The following elements are required:

processingKey	(string) Processing.
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 StartDate ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
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 SubjectValue ProcessingDeduction

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

The following elements are required:

processingKey	(string) Processing.
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 TotalCompanyDeductions Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Processing

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

The following elements are required:

processingKey	(string) Processing.
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 TotalEmployeeDeductions Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Type Processing

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

The following elements are required:

processingKey	(string) Processing.
companyKey	(string) The company key.
value	(enum ProcessingType) The request body should contain the new value for the attribute. See ProcessingType.

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 Unit ProcessingAbsence

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

The following elements are required:

processingKey	(string) Processing.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum Unit) The request body should contain the new value for the attribute. See Unit.

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 ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 Unjustified ProcessingTimeSheet

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

The following elements are required:

processingKey	(string) Processing.
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 User ProcessingRetroactive

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

The following elements are required:

processingKey	(string) Processing.
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 VacationDaysCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 VacationDaysCountUsed Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Value ProcessingEarning

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

The following elements are required:

processingKey	(string) Processing.
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 WeekHoursCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 WorkDaysCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 WorkDaysFullPeriodCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Worked30DaysMonthCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 Worked30DaysMonthCountInfo Processing

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

The following elements are required:

processingKey	(string) Processing.
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 WorkedCalendarDaysCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 WorkedWorkDaysCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 WorkedWorkHoursCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 WorkHoursCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 WorkHoursFullPeriodCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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 YearPeriodCount Processing

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

The following elements are required:

processingKey	(string) Processing.
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:

DELETE Operations

DELETE Processing Time Sheet by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

processingKey	(string) Processing.
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 Processing Absence by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

processingKey	(string) Processing.
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 Processing Earning by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

processingKey	(string) Processing.
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 Processing Deduction by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

processingKey	(string) Processing.
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 Processing Retroactive by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

processingKey	(string) Processing.
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 Processing 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 Processing by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
processingKey	(string) Processing.

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

ApiProcessingProcessingAbsencesResource

The following elements are required:

absenceType	(string) Absence Type.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
duration	(decimal) Duration.
absentCalendarDays	(decimal) Absent Calendar Days.
absentWorkDays	(decimal) Absent Work Days.
absentWorkHours	(decimal) Absent Work Hours.
unit	(enum Unit) Unit. See Unit.
absenceId	(Guid) Absence Id.
percentage	(decimal) Percentage.

ApiProcessingProcessingDeductionsProcDedByEarnNaturesResource

The following elements are required:

earningNature	(string) Earning Nature.
subjectValue	(MoneyResource) Subject. See MoneyResource .
exemptValue	(MoneyResource) PT translation: "Não sujeito". See MoneyResource .
freeValue	(MoneyResource) PT translation: "Isento Incidência". See MoneyResource .
taxBracketValue	(MoneyResource) Tax Bracket. See MoneyResource .
employeeValue	(MoneyResource) Employee. See MoneyResource .
companyValue	(MoneyResource) Company. See MoneyResource .
currency	(string) Currency.
baseValue	(MoneyResource) Taxable base. See MoneyResource .

ApiProcessingProcessingDeductionsResource

The following elements are required:

deduction	(string) Deduction.
sourceId	(Guid) Source Id.
name	(string) Name.
aggregation	(string) Aggregation.
subjectValue	(MoneyResource) Subject Value. See MoneyResource .
exemptValue	(MoneyResource) PT translation: "Não sujeito". See MoneyResource .
freeValue	(MoneyResource) PT translation: "Isento Incidência". See MoneyResource .
bracketValue	(MoneyResource) Bracket Value. See MoneyResource .
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
companyValue	(MoneyResource) Company Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

employeePercentage	(decimal) Employee %.
companyPercentage	(decimal) Company %.
procDedByEarnNatures	(List of ApiProcessingProcessingDeductionsProcDedByEarnNaturesResource) Proc. Ded. By Earning Natures. See ApiProcessingProcessingDeductionsProcDedByEarnNaturesResource.
info	(string) Info.

ApiProcessingProcessingEarningsProcDeductionsByEarningsResource

The following elements are required:

procDedByEarningNatureId	(Guid) Proc Ded By Earning Nature Id.
deduction	(string) Deduction.
subjectValue	(MoneyResource) Subject. See MoneyResource .
exemptValue	(MoneyResource) PT translation: "Não sujeito". See MoneyResource .
freeValue	(MoneyResource) PT translation: "Isento Incidência". See MoneyResource .
taxBracketValue	(MoneyResource) Tax Bracket. See MoneyResource .
employeeValue	(MoneyResource) Employee. See MoneyResource .
companyValue	(MoneyResource) Company. See MoneyResource .
currency	(string) Currency.

ApiProcessingProcessingEarningsResource

The following elements are required:

earning	(string) Earning.
earningNature	(string) Earning Nature.
aggregation	(string) Aggregation.
quantity	(decimal) Quantity.
unitValue	(decimal) Unit Value.
value	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.
netValue	(MoneyResource) Net Value. See MoneyResource .
grossValue	(MoneyResource) Gross Value. See MoneyResource .
referenceDate	(DateTime) Reference Date.

The following elements are optional:

sourceType	(enum ProcessingEarningSourceType) Source Type. See ProcessingEarningSourceType.
sourceId	(Guid) Source Id.
name	(string) Name.
info	(string) Info.
procDeductionsByEarnings	(List of ApiProcessingProcessingEarningsProcDeductionsByEarningsResource) Proc Deductions By Earnings. See ApiProcessingProcessingEarningsProcDeductionsByEarningsResource.

ApiProcessingProcessingRetroactivesResource

The following elements are optional:

modifiedDate	(DateTimeOffset) Modified Date.
source	(enum ProcessingRequestSourceType) Source. See ProcessingRequestSourceType.
user	(string) User.

ApiProcessingProcessingTimeSheetsResource

The following elements are required:

date	(DateTime) Date.
expected	(decimal) Expected Hours.
efective	(decimal) Efective Hours.
absence	(decimal) Absence Hours.
paid	(decimal) Paid Hours.
unjustified	(decimal) Unjustified Hours.

ApiProcessingResource

The following elements are required:

processingKey	(string) Processing.
contract	(string) Contract.
employee	(string) Employee.
periodYear	(int) Period Year.
periodMonth	(int) Period Month.
date	(DateTime) Period.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
number	(int) Number.
type	(enum ProcessingType) Type. See ProcessingType.
company	(string) Company.
currency	(string) Currency.
hourlyWage	(MoneyResource) Hourly Wage. See MoneyResource .
grossBaseAllowance	(MoneyResource) Gross Base Allowance Value - Earning value with the nature type for the base wage determined for the total period, excluding absences. See MoneyResource .
illiquidBaseAllowance	(MoneyResource) Illiquid Base Allowance Value - Earning value with the nature type for the base wage determined for the period, considering absences. See MoneyResource .
calendarDaysCount	(int) Total calendar days of the month.
workedCalendarDaysCount	(decimal) Number of worked calendar days (considering only absences in days).
absentCalendarDayCount	(decimal) Absence days in calendar days.
workDaysCount	(int) Work days determined by the work schedule.
workDaysFullPeriodCount	(int) Work Days Full Period Count.
workHoursCount	(decimal) Work hours determined by the work schedule.
workHoursFullPeriodCount	(decimal) Work Hours Full Period Count.
workedWorkDaysCount	(decimal) Expected days of work deducted from absences in days. See details in the time sheet.
workedWorkHoursCount	(decimal) Expected hours of work deducted from all absences. See details in the time sheet.
worked30DaysMonthCount	(decimal) Number of calendar days with work reduced of absences in days and on days with absences in hours considering half a day when worked hours in day is equal or less than half of predicted hours in that day with adjustment to a 30 day month.
absent30DaysMonthCount	(decimal) Absences in a 30 day count.
vacationDaysCount	(decimal) Vacation days taken in this period.
nextVacationDayCount	(decimal) Identifier for the period with the greatest number of vacation days scheduled.
yearPeriodCount	(int) Year Periods.
majVacationPeriod	(int) Vacation days scheduled in the next period.
lastPeriod	(int) Last Period.
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .
totalEmployeeDeductions	(MoneyResource) Total Employee Deductions. See MoneyResource .
totalCompanyDeductions	(MoneyResource) Total Company Deductions. See MoneyResource .
netValue	(MoneyResource) Net Value. See MoneyResource .
isClosed	(bool) Is Closed.
includeCessation	(bool) Include Cessation.
paidDaysCount	(decimal) Number of paid days.
paidHoursCount	(decimal) Number of paid hours.
absentUnjustifiedDaysCount	(decimal) Number of unjustified days of absence.
absentUnjustifiedHoursCount	(decimal) Number of unjustified hours of absence.
paidDays30DaysMonthCount	(decimal) Number of paid days with adjustment to a 30 day month.
absentUnjustifedDays30DaysMonthCount	(decimal) Number of days of unjustified absence with adjustment to a 30 day month.
vacationDaysCountUsed	(bool) Vacation Days Count Used.
nextVacationDayCountUsed	(bool) Next Vacation Day Count Used.
majVacationPeriodUsed	(bool) Maj Vacation Period Used.
isUser	(bool) User.
weekHoursCount	(decimal) Total hours per week according by contract schedule in this period.
companyWeekHoursCount	(decimal) Total hours per week according company schedule in this period.
isTimeSheetCompleted	(bool) Is Time Sheet Completed.
department	(string) Department.

The following elements are optional:

hourlyWageFormula	(enum HourlyWageFormula) Hourly Wage Formula. See HourlyWageFormula.
processingTimeSheets	(List of ApiProcessingProcessingTimeSheetsResource) Processing Time Sheets. See ApiProcessingProcessingTimeSheetsResource.
processingAbsences	(List of ApiProcessingProcessingAbsencesResource) Processing Absences. See ApiProcessingProcessingAbsencesResource.
processingEarnings	(List of ApiProcessingProcessingEarningsResource) Processing Earnings. See ApiProcessingProcessingEarningsResource.
processingDeductions	(List of ApiProcessingProcessingDeductionsResource) Processing Deductions. See ApiProcessingProcessingDeductionsResource.
processingRetroactives	(List of ApiProcessingProcessingRetroactivesResource) Processing Retroactives. See ApiProcessingProcessingRetroactivesResource.
hourlyWageInfo	(string) Hourly Wage Info.
worked30DaysMonthCountInfo	(string) Worked Days.
absent30DaysMonthCountInfo	(string) Absent Days.
estimatedEndDate	(DateTime) Estimated end date of the contract at the processing moment.
paymentPeriod	(DateTime) Payment Period.

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.

ProcDeductionsByEarningNatureResource

The following elements are required:

earningNature	(string) Earning Nature.
subjectValue	(MoneyResource) Subject. See MoneyResource .
exemptValue	(MoneyResource) PT translation: "Não sujeito". See MoneyResource .
freeValue	(MoneyResource) PT translation: "Isento Incidência". See MoneyResource .
taxBracketValue	(MoneyResource) Tax Bracket. See MoneyResource .
employeeValue	(MoneyResource) Employee. See MoneyResource .
companyValue	(MoneyResource) Company. See MoneyResource .
currency	(string) Currency.
baseValue	(MoneyResource) Taxable base. See MoneyResource .

ProcDeductionsByEarningResource

The following elements are required:

procDedByEarningNatureId	(Guid) Proc Ded By Earning Nature Id.
deduction	(string) Deduction.
subjectValue	(MoneyResource) Subject. See MoneyResource .
exemptValue	(MoneyResource) PT translation: "Não sujeito". See MoneyResource .
freeValue	(MoneyResource) PT translation: "Isento Incidência". See MoneyResource .
taxBracketValue	(MoneyResource) Tax Bracket. See MoneyResource .
employeeValue	(MoneyResource) Employee. See MoneyResource .
companyValue	(MoneyResource) Company. See MoneyResource .
currency	(string) Currency.

ProcessingAbsenceResource

The following elements are required:

absenceType	(string) Absence Type.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
duration	(decimal) Duration.
absentCalendarDays	(decimal) Absent Calendar Days.
absentWorkDays	(decimal) Absent Work Days.
absentWorkHours	(decimal) Absent Work Hours.
unit	(enum Unit) Unit. See Unit.
absenceId	(Guid) Absence Id.
percentage	(decimal) Percentage.

ProcessingDeductionResource

The following elements are required:

deduction	(string) Deduction.
sourceId	(Guid) Source Id.
name	(string) Name.
aggregation	(string) Aggregation.
subjectValue	(MoneyResource) Subject Value. See MoneyResource .
exemptValue	(MoneyResource) PT translation: "Não sujeito". See MoneyResource .
freeValue	(MoneyResource) PT translation: "Isento Incidência". See MoneyResource .
bracketValue	(MoneyResource) Bracket Value. See MoneyResource .
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
companyValue	(MoneyResource) Company Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

employeePercentage	(decimal) Employee %.
companyPercentage	(decimal) Company %.
procDedByEarnNatures	(List of ProcDeductionsByEarningNatureResource) Proc. Ded. By Earning Natures. See ProcDeductionsByEarningNatureResource.
info	(string) Info.

ProcessingEarningResource

The following elements are required:

earning	(string) Earning.
earningNature	(string) Earning Nature.
aggregation	(string) Aggregation.
quantity	(decimal) Quantity.
unitValue	(decimal) Unit Value.
value	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.
netValue	(MoneyResource) Net Value. See MoneyResource .
grossValue	(MoneyResource) Gross Value. See MoneyResource .
referenceDate	(DateTime) Reference Date.

The following elements are optional:

sourceType	(enum ProcessingEarningSourceType) Source Type. See ProcessingEarningSourceType.
sourceId	(Guid) Source Id.
name	(string) Name.
info	(string) Info.
procDeductionsByEarnings	(List of ProcDeductionsByEarningResource) Proc Deductions By Earnings. See ProcDeductionsByEarningResource.

ProcessingMainProcessingDeductionsResource

The following elements are required:

aggregation	(string) Aggregation.
companyValue	(MoneyResource) Company Value. See MoneyResource .
currency	(string) Currency.
deduction	(string) Deduction.
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
exemptValue	(MoneyResource) PT translation: "Não sujeito". See MoneyResource .
name	(string) Name.
sourceId	(Guid) Source Id.
subjectValue	(MoneyResource) Subject Value. See MoneyResource .
freeValue	(MoneyResource) PT translation: "Isento Incidência". See MoneyResource .
bracketValue	(MoneyResource) Bracket Value. See MoneyResource .

The following elements are optional:

companyPercentage	(decimal) Company %.
employeePercentage	(decimal) Employee %.

ProcessingMainProcessingEarningsResource

The following elements are required:

aggregation	(string) Aggregation.
currency	(string) Currency.
earning	(string) Earning.
quantity	(decimal) Quantity.
unitValue	(decimal) Unit Value.
value	(MoneyResource) Value. See MoneyResource .
earningNature	(string) Earning Nature.
netValue	(MoneyResource) Net Value. See MoneyResource .

The following elements are optional:

name	(string) Name.
sourceId	(Guid) Source Id.
sourceType	(enum ProcessingEarningSourceType) Source Type. See ProcessingEarningSourceType.

ProcessingMainResource

The following elements are required:

company	(string) Company.
contract	(string) Contract.
currency	(string) Currency.
netValue	(MoneyResource) Net Value. See MoneyResource .
number	(int) Number.
processingKey	(string) Processing.
totalCompanyDeductions	(MoneyResource) Total Company Deductions. See MoneyResource .
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .
totalEmployeeDeductions	(MoneyResource) Total Employee Deductions. See MoneyResource .
endDate	(DateTime) End Date.
isClosed	(bool) Is Closed.
startDate	(DateTime) Start Date.
employee	(string) Employee.
type	(enum ProcessingType) Type. See ProcessingType.
date	(DateTime) Period.
isUser	(bool) User.
isTimeSheetCompleted	(bool) Is Time Sheet Completed.

The following elements are optional:

processingDeductions	(List of ProcessingMainProcessingDeductionsResource) Processing Deductions. See ProcessingMainProcessingDeductionsResource.
processingEarnings	(List of ProcessingMainProcessingEarningsResource) Processing Earnings. See ProcessingMainProcessingEarningsResource.
paymentPeriod	(DateTime) Payment Period.

ProcessingResource

The following elements are required:

processingKey	(string) Processing.
contract	(string) Contract.
employee	(string) Employee.
periodYear	(int) Period Year.
periodMonth	(int) Period Month.
date	(DateTime) Period.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
number	(int) Number.
type	(enum ProcessingType) Type. See ProcessingType.
company	(string) Company.
currency	(string) Currency.
hourlyWage	(MoneyResource) Hourly Wage. See MoneyResource .
grossBaseAllowance	(MoneyResource) Gross Base Allowance Value - Earning value with the nature type for the base wage determined for the total period, excluding absences. See MoneyResource .
illiquidBaseAllowance	(MoneyResource) Illiquid Base Allowance Value - Earning value with the nature type for the base wage determined for the period, considering absences. See MoneyResource .
calendarDaysCount	(int) Total calendar days of the month.
workedCalendarDaysCount	(decimal) Number of worked calendar days (considering only absences in days).
absentCalendarDayCount	(decimal) Absence days in calendar days.
workDaysCount	(int) Work days determined by the work schedule.
workDaysFullPeriodCount	(int) Work Days Full Period Count.
workHoursCount	(decimal) Work hours determined by the work schedule.
workHoursFullPeriodCount	(decimal) Work Hours Full Period Count.
workedWorkDaysCount	(decimal) Expected days of work deducted from absences in days. See details in the time sheet.
workedWorkHoursCount	(decimal) Expected hours of work deducted from all absences. See details in the time sheet.
worked30DaysMonthCount	(decimal) Number of calendar days with work reduced of absences in days and on days with absences in hours considering half a day when worked hours in day is equal or less than half of predicted hours in that day with adjustment to a 30 day month.
absent30DaysMonthCount	(decimal) Absences in a 30 day count.
vacationDaysCount	(decimal) Vacation days taken in this period.
nextVacationDayCount	(decimal) Identifier for the period with the greatest number of vacation days scheduled.
yearPeriodCount	(int) Year Periods.
majVacationPeriod	(int) Vacation days scheduled in the next period.
lastPeriod	(int) Last Period.
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .
totalEmployeeDeductions	(MoneyResource) Total Employee Deductions. See MoneyResource .
totalCompanyDeductions	(MoneyResource) Total Company Deductions. See MoneyResource .
netValue	(MoneyResource) Net Value. See MoneyResource .
isClosed	(bool) Is Closed.
includeCessation	(bool) Include Cessation.
paidDaysCount	(decimal) Number of paid days.
paidHoursCount	(decimal) Number of paid hours.
absentUnjustifiedDaysCount	(decimal) Number of unjustified days of absence.
absentUnjustifiedHoursCount	(decimal) Number of unjustified hours of absence.
paidDays30DaysMonthCount	(decimal) Number of paid days with adjustment to a 30 day month.
absentUnjustifedDays30DaysMonthCount	(decimal) Number of days of unjustified absence with adjustment to a 30 day month.
vacationDaysCountUsed	(bool) Vacation Days Count Used.
nextVacationDayCountUsed	(bool) Next Vacation Day Count Used.
majVacationPeriodUsed	(bool) Maj Vacation Period Used.
isUser	(bool) User.
weekHoursCount	(decimal) Total hours per week according by contract schedule in this period.
companyWeekHoursCount	(decimal) Total hours per week according company schedule in this period.
isTimeSheetCompleted	(bool) Is Time Sheet Completed.
department	(string) Department.

The following elements are optional:

hourlyWageFormula	(enum HourlyWageFormula) Hourly Wage Formula. See HourlyWageFormula.
processingTimeSheets	(List of ProcessingTimeSheetResource) Processing Time Sheets. See ProcessingTimeSheetResource.
processingAbsences	(List of ProcessingAbsenceResource) Processing Absences. See ProcessingAbsenceResource.
processingEarnings	(List of ProcessingEarningResource) Processing Earnings. See ProcessingEarningResource.
processingDeductions	(List of ProcessingDeductionResource) Processing Deductions. See ProcessingDeductionResource.
processingRetroactives	(List of ProcessingRetroactiveResource) Processing Retroactives. See ProcessingRetroactiveResource.
hourlyWageInfo	(string) Hourly Wage Info.
worked30DaysMonthCountInfo	(string) Worked Days.
absent30DaysMonthCountInfo	(string) Absent Days.
estimatedEndDate	(DateTime) Estimated end date of the contract at the processing moment.
paymentPeriod	(DateTime) Payment Period.

ProcessingRetroactiveResource

The following elements are optional:

modifiedDate	(DateTimeOffset) Modified Date.
source	(enum ProcessingRequestSourceType) Source. See ProcessingRequestSourceType.
user	(string) User.

ProcessingTimeSheetResource

The following elements are required:

date	(DateTime) Date.
expected	(decimal) Expected Hours.
efective	(decimal) Efective Hours.
absence	(decimal) Absence Hours.
paid	(decimal) Paid Hours.
unjustified	(decimal) Unjustified Hours.