Payroll | Configure Nature
Overview
| URL | api/{tenantKey}/{orgKey}/payrollCore/configureNatures |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
GET Configure Nature
Returns the list of entity records that can be processed by the 'EarningNatures' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| startPeriod | (DateTime) Start Period. |
| originDeduction | (string) Origin Deduction. |
The following elements are optional:
| deductionToReplicate | (string) Deduction To Replicate This is a query string parameter. |
| contractKind | (int?) Contract Kind This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ConfigureNatureLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollCore/configureNatures/{pageIndex}/{pageSize}?deductionToReplicate={deductionToReplicate}&contractKind={contractKind}
GET /payrollCore/configureNatures/{pageIndex}/{pageSize}?deductionToReplicate={deductionToReplicate}&contractKind={contractKind}
POST Configure Nature
Instructs the 'EarningNatures' service to process the specified entity records.
The following elements are required:
| list | (ConfigureNatureLine) List of the entity records that should be processed. See ConfigureNatureLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollCore/configureNatures/{companyKey}
POST /payrollCore/configureNatures/{companyKey}
Resources
ConfigureNatureLine
The following elements are required:
| selected | (bool) Selected. |
| earningNature | (string) Earning Nature. |
| startPeriod | (DateTime) Start Period. |
| calculationBaseType | (enum CalculationBaseType) Calculation Base Type.
See CalculationBaseType. |
| exemptUntilKind | (enum QuantityKind) Exempt Until Kind.
See QuantityKind. |
| exemptUntil | (decimal) PT translation: "Não sujeito até". |
| exemptAfter | (decimal) PT translation: "Não sujeito após". |
| baseValueClassification | (string) Base Value Classification. |
| baseKind | (enum QuantityKind) Base Kind.
See QuantityKind. |
The following elements are optional:
| baseValue | (decimal) Base Value. |
| exemptUntilFormula | (string) Exempt Until Formula. |
| exemptValueClassification | (string) PT translation: "Classificação de valor não sujeito". |
| freeValueClassification | (string) PT translation: "Classificação de valor isento de incidência". |
| baseFormula | (string) Base Formula. |
| contrTaxBracketKind | (enum ContrTaxBracketKind) Contribution kind to tax bracket.
See ContrTaxBracketKind. |
| contrTaxBracketFormula | (string) Contributes to tax bracket formula. |
ConfigureNaturesMain
The following elements are required:
| selectedCount | (int) Selected Count. |
| startPeriod | (DateTime) Start Period. |
| originDeduction | (string) Origin Deduction. |
The following elements are optional:
| deductionToReplicate | (string) Deduction To Replicate. |
| contractKind | (int) Contract Kind. |