Payroll | Contract Cumulated
Service to manage entities of type 'ContractCumulated'.
This service extends Contracts.
Overview
| URL | api/{tenantKey}/{orgKey}/payroll/contractCumulateds |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET ContractCumulateds
- GET ContractCumulateds (paged)
- GET ContractCumulated by identifier
- GET ContractCumulated by key
- GET ContractCumulateds (with Contract)
- GET ContractCumulateds (with Contract) (paged)
- GET ContractCumulated (with Contract) by identifier
- GET ContractCumulated (with Contract) by key
- GET Get Cumulateds By Employee
- POST:
-
PUT:
- PUT Set IsActive ContractCumulated
- PUT Set Year ContractCumulatedValue
- PUT Set Deduction ContractCumulatedValue
- PUT Set EarningNature ContractCumulatedValue
- PUT Set SubjectValue ContractCumulatedValue
- PUT Set ExemptValue ContractCumulatedValue
- PUT Set FreeValue ContractCumulatedValue
- PUT Set EmployeeValue ContractCumulatedValue
- PUT Set CompanyValue ContractCumulatedValue
- PUT Set Currency ContractCumulatedValue
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseContractCumulatedContractCumulatedValuesResource
- ApiBaseContractCumulatedResource
- ApiContractCumulatedContractCumulatedValuesResource
- ApiContractCumulatedResource
- BaseContractCumulatedContractCumulatedValuesResource
- BaseContractCumulatedResource
- ContractCumulatedDetailResource
- ContractCumulatedResource
- ContractCumulatedValueResource
- MoneyResource
All Enumerations
This service uses the following enumerations:
GET ContractCumulateds
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See ContractCumulatedResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/extension
GET /payroll/contractCumulateds/extension
GET ContractCumulateds (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 ContractCumulatedResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/extension?page={page}&pageSize={pageSize}
GET /payroll/contractCumulateds/extension?page={page}&pageSize={pageSize}
GET ContractCumulated 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 ContractCumulatedResource. |
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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{id}/extension
GET /payroll/contractCumulateds/{id}/extension
GET ContractCumulated by key
Returns the entity record that matches the specified key.
The following elements are required:
| contractKey | (string) Contract. |
Response:
| When successful, the response body contains the entity record. See ContractCumulatedResource. |
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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/extension
GET /payroll/contractCumulateds/{contractKey}/extension
GET ContractCumulateds (with Contract)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
| When successful, the response body contains the list of records available. See BaseContractCumulatedResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds
GET /payroll/contractCumulateds
GET ContractCumulateds (with Contract) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
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 BaseContractCumulatedResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds?page={page}&pageSize={pageSize}
GET /payroll/contractCumulateds?page={page}&pageSize={pageSize}
GET ContractCumulated (with Contract) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See BaseContractCumulatedResource. |
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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{id}
GET /payroll/contractCumulateds/{id}
GET ContractCumulated (with Contract) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
| contractKey | (string) Contract. |
Response:
| When successful, the response body contains the entity record. See BaseContractCumulatedResource. |
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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}
GET /payroll/contractCumulateds/{contractKey}
GET Get Cumulateds By Employee
Custom operation 'GetCumulatedsByEmployee'.
The following elements are required:
| company | (string) Company. |
| employee | (string) Employee. |
| year | (int) Year. |
Response:
| When successful, the response body contains a list of resources of type 'ContractCumulatedDetailResource'. See ContractCumulatedDetailResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/getCumulatedsByEmployee/{company}/{employee}/{year}
GET /payroll/contractCumulateds/getCumulatedsByEmployee/{company}/{employee}/{year}
POST ContractCumulateds
Creates a new entity record.
The following elements are required:
| contractCumulatedResource | (ApiContractCumulatedResource) The request body should contain the entity record that should be created. See ApiContractCumulatedResource. |
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 ApiContractCumulatedResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/extension
POST /payroll/contractCumulateds/extension
POST ContractCumulateds (with ApiBaseContractCumulated)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| contractCumulatedResource | (ApiContractCumulatedResource) The request body should contain the entity record that should be created. See ApiContractCumulatedResource. |
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 ApiBaseContractCumulatedResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds
POST /payroll/contractCumulateds
POST Contract Cumulated
Inserts a new 'Contract Cumulated Value' in the 'Contract Cumulated'.
The following elements are required:
| contractKey | (string) Contract. |
| value | (ApiContractCumulatedContractCumulatedValuesResource) The ApiContractCumulatedContractCumulatedValuesResource instance. See ApiContractCumulatedContractCumulatedValuesResource. |
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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues
POST /payroll/contractCumulateds/{contractKey}/contractCumulatedValues
PUT Set CompanyValue ContractCumulatedValue
Updates the value of attribute 'CompanyValue' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/companyValue
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/companyValue
PUT Set Currency ContractCumulatedValue
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/currency
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/currency
PUT Set Deduction ContractCumulatedValue
Updates the value of attribute 'Deduction' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/deduction
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/deduction
PUT Set EarningNature ContractCumulatedValue
Updates the value of attribute 'EarningNature' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/earningNature
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/earningNature
PUT Set EmployeeValue ContractCumulatedValue
Updates the value of attribute 'EmployeeValue' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/employeeValue
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/employeeValue
PUT Set ExemptValue ContractCumulatedValue
Updates the value of attribute 'ExemptValue' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/exemptValue
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/exemptValue
PUT Set FreeValue ContractCumulatedValue
Updates the value of attribute 'FreeValue' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/freeValue
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/freeValue
PUT Set IsActive ContractCumulated
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/isActive
PUT /payroll/contractCumulateds/{contractKey}/isActive
PUT Set SubjectValue ContractCumulatedValue
Updates the value of attribute 'SubjectValue' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/subjectValue
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/subjectValue
PUT Set Year ContractCumulatedValue
Updates the value of attribute 'Year' in the specified entity record.
The following elements are required:
| contractKey | (string) Contract. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/year
PUT /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}/year
DELETE Contract Cumulated Value by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| contractKey | (string) Contract. |
| 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}
DELETE /payroll/contractCumulateds/{contractKey}/contractCumulatedValues/{lineId}
DELETE ContractCumulated 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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{id}
DELETE /payroll/contractCumulateds/{id}
DELETE ContractCumulated by key
Deletes the entity record that matches the specified key.
The following elements are required:
| contractKey | (string) Contract. |
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:
api/{tenantKey}/{orgKey}/payroll/contractCumulateds/{contractKey}
DELETE /payroll/contractCumulateds/{contractKey}
Resources
ApiBaseContractCumulatedContractCumulatedValuesResource
The following elements are required:
| year | (int) Year. |
| deduction | (string) Deduction. |
| earningNature | (string) Earning Nature. |
| subjectValue | (MoneyResource) Subject Value.
See MoneyResource . |
| exemptValue | (MoneyResource) Exempt Value.
See MoneyResource . |
| freeValue | (MoneyResource) Free Value.
See MoneyResource . |
| employeeValue | (MoneyResource) Employee Value.
See MoneyResource . |
| companyValue | (MoneyResource) Company Value.
See MoneyResource . |
| currency | (string) Currency. |
ApiBaseContractCumulatedResource
The following elements are required:
| contractKey | (string) Contract. |
| contractState | (enum ContractState) State.
See ContractState. |
| employee | (string) Employee. |
| company | (string) Company. |
| hiringDate | (DateTime) Hiring Date. |
| hiringReason | (string) Hiring Reason. |
| trialPeriodDays | (int) Trial Period Days. |
| workLocation | (string) Work Location. |
| workTimeDuration | (enum WorkTimeDuration) Work Time Duration.
See WorkTimeDuration. |
| hourlyWageFormula | (enum HourlyWageFormula) Hourly Wage Formula.
See HourlyWageFormula. |
| hourlyWage | (MoneyResource) Hourly Wage.
See MoneyResource . |
| currency | (string) Currency. |
| paymentMethod | (string) Payment Method. |
| contractActive | (bool) Active. |
| processingStartPeriod | (DateTime) Processing Start Period. |
| contractPostingProfile | (string) Contract Posting Profile. |
| nonWorkingDays | (string) Non Working Days. |
| country | (string) Country. |
| contractKind | (enum ContractKind) Contract Kind.
See ContractKind. |
| department | (string) Department. |
The following elements are optional:
| contractCumulatedValues | (List of ApiBaseContractCumulatedContractCumulatedValuesResource) Contract Cumulated Values.
See ApiBaseContractCumulatedContractCumulatedValuesResource. |
| picture | (string) Picture. |
| trialPeriodEndDate | (DateTime) Trial Period End Date. |
| estimatedEndDate | (DateTime) Estimated End Date. |
| endDate | (DateTime) End Date. |
| leavingReason | (string) Leaving Reason. |
| remarks | (string) Remarks. |
| isEditableHiringDate | (bool) Is Editable Hiring Date. |
| searchTerm | (string) Atributo temporário até bug framework estar resolvido. |
| iBAN | (string) The finacial account's International Bank Account Number. |
| sWIFT | (string) The society for Worldwide Interbank Financial Telecommunication number. |
| schedule | (string) Schedule. |
| profession | (string) Profession. |
| professionalCategory | (string) Professional Category. |
| workRuleSet | (string) Work Rule Set. |
| companyExpiryPriorNoticeDate | (DateTime) Comp. Expiry Prior Notice Date. |
| activeContractualPlanEstimatedEndDate | (DateTime) Contractual Plan Est. End Date. |
ApiContractCumulatedContractCumulatedValuesResource
The following elements are required:
| year | (int) Year. |
| deduction | (string) Deduction. |
| earningNature | (string) Earning Nature. |
| subjectValue | (MoneyResource) Subject Value.
See MoneyResource . |
| exemptValue | (MoneyResource) Exempt Value.
See MoneyResource . |
| freeValue | (MoneyResource) Free Value.
See MoneyResource . |
| employeeValue | (MoneyResource) Employee Value.
See MoneyResource . |
| companyValue | (MoneyResource) Company Value.
See MoneyResource . |
| currency | (string) Currency. |
ApiContractCumulatedResource
The following elements are required:
| contractKey | (string) Contract. |
The following elements are optional:
| contractCumulatedValues | (List of ApiContractCumulatedContractCumulatedValuesResource) Contract Cumulated Values.
See ApiContractCumulatedContractCumulatedValuesResource. |
BaseContractCumulatedContractCumulatedValuesResource
The following elements are required:
| year | (int) Year. |
| deduction | (string) Deduction. |
| earningNature | (string) Earning Nature. |
| subjectValue | (MoneyResource) Subject Value.
See MoneyResource . |
| exemptValue | (MoneyResource) Exempt Value.
See MoneyResource . |
| freeValue | (MoneyResource) Free Value.
See MoneyResource . |
| employeeValue | (MoneyResource) Employee Value.
See MoneyResource . |
| companyValue | (MoneyResource) Company Value.
See MoneyResource . |
| currency | (string) Currency. |
BaseContractCumulatedResource
The following elements are required:
| contractKey | (string) Contract. |
| contractState | (enum ContractState) State.
See ContractState. |
| employee | (string) Employee. |
| company | (string) Company. |
| hiringDate | (DateTime) Hiring Date. |
| hiringReason | (string) Hiring Reason. |
| trialPeriodDays | (int) Trial Period Days. |
| workLocation | (string) Work Location. |
| workTimeDuration | (enum WorkTimeDuration) Work Time Duration.
See WorkTimeDuration. |
| hourlyWageFormula | (enum HourlyWageFormula) Hourly Wage Formula.
See HourlyWageFormula. |
| hourlyWage | (MoneyResource) Hourly Wage.
See MoneyResource . |
| currency | (string) Currency. |
| paymentMethod | (string) Payment Method. |
| contractActive | (bool) Active. |
| processingStartPeriod | (DateTime) Processing Start Period. |
| contractPostingProfile | (string) Contract Posting Profile. |
| nonWorkingDays | (string) Non Working Days. |
| country | (string) Country. |
| contractKind | (enum ContractKind) Contract Kind.
See ContractKind. |
| department | (string) Department. |
The following elements are optional:
| contractCumulatedValues | (List of BaseContractCumulatedContractCumulatedValuesResource) Contract Cumulated Values.
See BaseContractCumulatedContractCumulatedValuesResource. |
| picture | (string) Picture. |
| trialPeriodEndDate | (DateTime) Trial Period End Date. |
| estimatedEndDate | (DateTime) Estimated End Date. |
| endDate | (DateTime) End Date. |
| leavingReason | (string) Leaving Reason. |
| remarks | (string) Remarks. |
| isEditableHiringDate | (bool) Is Editable Hiring Date. |
| searchTerm | (string) Atributo temporário até bug framework estar resolvido. |
| iBAN | (string) The finacial account's International Bank Account Number. |
| sWIFT | (string) The society for Worldwide Interbank Financial Telecommunication number. |
| schedule | (string) Schedule. |
| profession | (string) Profession. |
| professionalCategory | (string) Professional Category. |
| workRuleSet | (string) Work Rule Set. |
| companyExpiryPriorNoticeDate | (DateTime) Comp. Expiry Prior Notice Date. |
| activeContractualPlanEstimatedEndDate | (DateTime) Contractual Plan Est. End Date. |
ContractCumulatedDetailResource
The following elements are required:
| baseValue | (MoneyResource) Taxable base.
See MoneyResource . |
| companyValue | (MoneyResource) Company Value.
See MoneyResource . |
| currency | (string) Currency. |
| deduction | (string) Deduction. |
| earningNature | (string) Earning Nature. |
| employeeValue | (MoneyResource) Employee Value.
See MoneyResource . |
| exemptValue | (MoneyResource) Exempt Value.
See MoneyResource . |
| freeValue | (MoneyResource) Free Value.
See MoneyResource . |
| subjectValue | (MoneyResource) Subject Value.
See MoneyResource . |
| year | (int) Year. |
ContractCumulatedResource
The following elements are required:
| contractKey | (string) Contract. |
The following elements are optional:
| contractCumulatedValues | (List of ContractCumulatedValueResource) Contract Cumulated Values.
See ContractCumulatedValueResource. |
ContractCumulatedValueResource
The following elements are required:
| year | (int) Year. |
| deduction | (string) Deduction. |
| earningNature | (string) Earning Nature. |
| baseValue | (MoneyResource) Taxable base.
See MoneyResource . |
| subjectValue | (MoneyResource) Subject Value.
See MoneyResource . |
| exemptValue | (MoneyResource) Exempt Value.
See MoneyResource . |
| freeValue | (MoneyResource) Free Value.
See MoneyResource . |
| employeeValue | (MoneyResource) Employee Value.
See MoneyResource . |
| companyValue | (MoneyResource) Company Value.
See MoneyResource . |
| currency | (string) Currency. |
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.