ROSEPEOPLE Developers - Web API Reference

Portuguese Payroll | Tax Data Contract

Service to manage entities of type 'TaxDataContract'.

This service extends Contracts.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET TaxDataContracts

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payrollPT/taxDataContracts/extension

GET TaxDataContracts (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 TaxDataContractResource.

Response status codes:

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

Resource URL:

GET /payrollPT/taxDataContracts/extension?page={page}&pageSize={pageSize}

GET TaxDataContract 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 TaxDataContractResource.

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 /payrollPT/taxDataContracts/{id}/extension

GET TaxDataContract 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 TaxDataContractResource.

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 /payrollPT/taxDataContracts/{contractKey}/extension

GET TaxDataContracts (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 BaseTaxDataContractResource.

Response status codes:

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

Resource URL:

GET /payrollPT/taxDataContracts

GET TaxDataContracts (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 BaseTaxDataContractResource.

Response status codes:

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

Resource URL:

GET /payrollPT/taxDataContracts?page={page}&pageSize={pageSize}

GET TaxDataContract (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 BaseTaxDataContractResource.

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 /payrollPT/taxDataContracts/{id}

GET TaxDataContract (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 BaseTaxDataContractResource.

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 /payrollPT/taxDataContracts/{contractKey}

POST Operations

POST TaxDataContracts

Creates a new entity record.

The following elements are required:

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

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

POST /payrollPT/taxDataContracts/extension

POST TaxDataContracts (with ApiBaseTaxDataContract)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

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

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

POST /payrollPT/taxDataContracts

POST Tax Data Contract

Inserts a new 'Tax Data Contract Period' in the 'Tax Data Contract'.

The following elements are required:

contractKey (string) Contract.
value (ApiTaxDataContractTaxDataContractPeriodsResource) The ApiTaxDataContractTaxDataContractPeriodsResource instance.
See ApiTaxDataContractTaxDataContractPeriodsResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods

POST Tax Data Contract

Inserts a new 'Tax Data Working Time' in the 'Tax Data Contract'.

The following elements are required:

contractKey (string) Contract.
value (ApiTaxDataContractTaxDataWorkingTimesResource) The ApiTaxDataContractTaxDataWorkingTimesResource instance.
See ApiTaxDataContractTaxDataWorkingTimesResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 /payrollPT/taxDataContracts/{contractKey}/taxDataWorkingTimes

PUT Operations

PUT Set ActivityCode TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
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 /payrollPT/taxDataContracts/{contractKey}/activityCode

PUT Set ContractKind TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
value (enum ContractKind) The request body should contain the new value for the attribute.
See ContractKind.

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 /payrollPT/taxDataContracts/{contractKey}/contractKind

PUT Set Dependants TaxDataContractPeriod

Updates the value of attribute 'Dependants' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/dependants

PUT Set DisabilityDegreeDependents TaxDataContractPeriod

Updates the value of attribute 'DisabilityDegreeDependents' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/disabilityDegreeDependents

PUT Set DisabilityDegreeHolder TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
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 /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/disabilityDegreeHolder

PUT Set DisabilityFactor TaxDataContractPeriod

Updates the value of attribute 'DisabilityFactor' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/disabilityFactor

PUT Set DisabilityFunctionTax TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
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 /payrollPT/taxDataContracts/{contractKey}/disabilityFunctionTax

PUT Set Duration TaxDataWorkingTime

Updates the value of attribute 'Duration' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataWorkingTimes/{lineId}/duration

PUT Set EarningHolders TaxDataContractPeriod

Updates the value of attribute 'EarningHolders' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/earningHolders

PUT Set EarningType TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
value (enum EarningType) The request body should contain the new value for the attribute.
See EarningType.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/earningType

PUT Set EconomicActivityClassification TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
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 /payrollPT/taxDataContracts/{contractKey}/economicActivityClassification

PUT Set FiscalState TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
value (enum FiscalState) The request body should contain the new value for the attribute.
See FiscalState.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/fiscalState

PUT Set FixedTax TaxDataContractPeriod

Updates the value of attribute 'FixedTax' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/fixedTax

PUT Set IrctApplicability TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
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 /payrollPT/taxDataContracts/{contractKey}/irctApplicability

PUT Set IsActive TaxDataContract

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:

PUT /payrollPT/taxDataContracts/{contractKey}/isActive

PUT Set MortgageLoanWithholdingRegime TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
value (enum MortgageLoanWithholdingRegime) The request body should contain the new value for the attribute.
See MortgageLoanWithholdingRegime.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/mortgageLoanWithholdingRegime

PUT Set Organization TaxDataWorkingTime

Updates the value of attribute 'Organization' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataWorkingTimes/{lineId}/organization

PUT Set PeriodEnd TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
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 /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/periodEnd

PUT Set PeriodEnd TaxDataWorkingTime

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
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 /payrollPT/taxDataContracts/{contractKey}/taxDataWorkingTimes/{lineId}/periodEnd

PUT Set PeriodStart TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
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 /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/periodStart

PUT Set PeriodStart TaxDataWorkingTime

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
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 /payrollPT/taxDataContracts/{contractKey}/taxDataWorkingTimes/{lineId}/periodStart

PUT Set ProfessionalStatus TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
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 /payrollPT/taxDataContracts/{contractKey}/professionalStatus

PUT Set QualificationLevel TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
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 /payrollPT/taxDataContracts/{contractKey}/qualificationLevel

PUT Set SecondHolderDisabilityDegree TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
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 /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/secondHolderDisabilityDegree

PUT Set SecondHolderMajorEarning TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
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 /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/secondHolderMajorEarning

PUT Set TaxJurisdictionService TaxDataContractPeriod

Updates the value of attribute 'TaxJurisdictionService' 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:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/taxJurisdictionService

PUT Set TaxRegionalArea TaxDataContract

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

The following elements are required:

contractKey (string) Contract.
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 /payrollPT/taxDataContracts/{contractKey}/taxRegionalArea

PUT Set TaxResidence TaxDataContractPeriod

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

The following elements are required:

contractKey (string) Contract.
lineId (string) The detail identifier.
value (enum TaxResidence) The request body should contain the new value for the attribute.
See TaxResidence.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/taxResidence

PUT Set Custom Attribute TaxDataContract

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

contractKey (string) Contract
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

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 /payrollPT/taxDataContracts/{contractKey}/{customAttributeName}

PUT Set Custom Attribute TaxDataContractPeriod

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

contractKey (string) Contract
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

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 /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}/{customAttributeName}

DELETE Operations

DELETE Tax Data Contract Period 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:

DELETE /payrollPT/taxDataContracts/{contractKey}/taxDataContractPeriods/{lineId}

DELETE Tax Data Working Time 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:

DELETE /payrollPT/taxDataContracts/{contractKey}/taxDataWorkingTimes/{lineId}

DELETE TaxDataContract 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 /payrollPT/taxDataContracts/{id}

DELETE TaxDataContract 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:

DELETE /payrollPT/taxDataContracts/{contractKey}

Resources


ApiBaseTaxDataContractResource

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

The following elements are optional:

taxDataContractPeriods (List of ApiBaseTaxDataContractTaxDataContractPeriodsResource) Tax Data Contract Periods.
See ApiBaseTaxDataContractTaxDataContractPeriodsResource.
professionalStatus (string) Professional status.
irctApplicability (string) IRCT Applicability.
qualificationLevel (string) Qualification Level.
disabilityFunctionTax (decimal) Disability for function tax.
taxDataWorkingTimes (List of ApiBaseTaxDataContractTaxDataWorkingTimesResource) Tax Data Working Times.
See ApiBaseTaxDataContractTaxDataWorkingTimesResource.
economicActivityClassification (string) Economic Activity Classification.
activityCode (string) Activity.
contractKind (enum ContractKind) Contract Kind.
See ContractKind.
taxRegionalArea (string) Tax Regional Area.
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.


ApiBaseTaxDataContractTaxDataContractPeriodsResource

The following elements are required:

periodStart (DateTime) Start Period.
earningType (enum EarningType) Earning Type.
See EarningType.
fiscalState (enum FiscalState) Fiscal State.
See FiscalState.
disabilityDegreeHolder (bool) Disability degree >= 60%.
earningHolders (int) Earning Holders.
secondHolderMajorEarning (bool) Sec. Holder Major Earning.
secondHolderDisabilityDegree (bool) Second Holder Disability degree >= 60%.
dependants (int) Dependants without disab. Degree.
disabilityDegreeDependents (int) Dependants w/ disab. Degree >= 60%.
taxResidence (enum TaxResidence) Tax Residence.
See TaxResidence.

The following elements are optional:

periodEnd (DateTime) End Period.
fixedTax (decimal) Fixed Tax.
taxJurisdictionService (string) Tax Jurisdiction Service.
disabilityFactor (int) Disability Factor.
mortgageLoanWithholdingRegime (enum MortgageLoanWithholdingRegime) Special withhold regime for mortgage loan holders.
See MortgageLoanWithholdingRegime.


ApiBaseTaxDataContractTaxDataWorkingTimesResource

The following elements are required:

periodStart (DateTime) Start Period.
duration (string) Duration.
organization (string) Organization.

The following elements are optional:

periodEnd (DateTime) End Period.


ApiTaxDataContractResource

The following elements are required:

contractKey (string) Contract.

The following elements are optional:

taxDataContractPeriods (List of ApiTaxDataContractTaxDataContractPeriodsResource) Tax Data Contract Periods.
See ApiTaxDataContractTaxDataContractPeriodsResource.
professionalStatus (string) Professional status.
irctApplicability (string) IRCT Applicability.
qualificationLevel (string) Qualification Level.
disabilityFunctionTax (decimal) Disability for function tax.
taxDataWorkingTimes (List of ApiTaxDataContractTaxDataWorkingTimesResource) Tax Data Working Times.
See ApiTaxDataContractTaxDataWorkingTimesResource.
economicActivityClassification (string) Economic Activity Classification.
activityCode (string) Activity.
contractKind (enum ContractKind) Contract Kind.
See ContractKind.
taxRegionalArea (string) Tax Regional Area.


ApiTaxDataContractTaxDataContractPeriodsResource

The following elements are required:

periodStart (DateTime) Start Period.
earningType (enum EarningType) Earning Type.
See EarningType.
fiscalState (enum FiscalState) Fiscal State.
See FiscalState.
disabilityDegreeHolder (bool) Disability degree >= 60%.
earningHolders (int) Earning Holders.
secondHolderMajorEarning (bool) Sec. Holder Major Earning.
secondHolderDisabilityDegree (bool) Second Holder Disability degree >= 60%.
dependants (int) Dependants without disab. Degree.
disabilityDegreeDependents (int) Dependants w/ disab. Degree >= 60%.
taxResidence (enum TaxResidence) Tax Residence.
See TaxResidence.

The following elements are optional:

periodEnd (DateTime) End Period.
fixedTax (decimal) Fixed Tax.
taxJurisdictionService (string) Tax Jurisdiction Service.
disabilityFactor (int) Disability Factor.
mortgageLoanWithholdingRegime (enum MortgageLoanWithholdingRegime) Special withhold regime for mortgage loan holders.
See MortgageLoanWithholdingRegime.


ApiTaxDataContractTaxDataWorkingTimesResource

The following elements are required:

periodStart (DateTime) Start Period.
duration (string) Duration.
organization (string) Organization.

The following elements are optional:

periodEnd (DateTime) End Period.


BaseTaxDataContractResource

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

The following elements are optional:

taxDataContractPeriods (List of BaseTaxDataContractTaxDataContractPeriodsResource) Tax Data Contract Periods.
See BaseTaxDataContractTaxDataContractPeriodsResource.
professionalStatus (string) Professional status.
irctApplicability (string) IRCT Applicability.
qualificationLevel (string) Qualification Level.
disabilityFunctionTax (decimal) Disability for function tax.
taxDataWorkingTimes (List of BaseTaxDataContractTaxDataWorkingTimesResource) Tax Data Working Times.
See BaseTaxDataContractTaxDataWorkingTimesResource.
economicActivityClassification (string) Economic Activity Classification.
activityCode (string) Activity.
contractKind (enum ContractKind) Contract Kind.
See ContractKind.
taxRegionalArea (string) Tax Regional Area.
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.


BaseTaxDataContractTaxDataContractPeriodsResource

The following elements are required:

periodStart (DateTime) Start Period.
earningType (enum EarningType) Earning Type.
See EarningType.
fiscalState (enum FiscalState) Fiscal State.
See FiscalState.
disabilityDegreeHolder (bool) Disability degree >= 60%.
earningHolders (int) Earning Holders.
secondHolderMajorEarning (bool) Sec. Holder Major Earning.
secondHolderDisabilityDegree (bool) Second Holder Disability degree >= 60%.
dependants (int) Dependants without disab. Degree.
disabilityDegreeDependents (int) Dependants w/ disab. Degree >= 60%.
taxResidence (enum TaxResidence) Tax Residence.
See TaxResidence.

The following elements are optional:

periodEnd (DateTime) End Period.
fixedTax (decimal) Fixed Tax.
taxJurisdictionService (string) Tax Jurisdiction Service.
disabilityFactor (int) Disability Factor.
mortgageLoanWithholdingRegime (enum MortgageLoanWithholdingRegime) Special withhold regime for mortgage loan holders.
See MortgageLoanWithholdingRegime.


BaseTaxDataContractTaxDataWorkingTimesResource

The following elements are required:

periodStart (DateTime) Start Period.
duration (string) Duration.
organization (string) Organization.

The following elements are optional:

periodEnd (DateTime) End 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.



TaxDataContractPeriodResource

The following elements are required:

periodStart (DateTime) Start Period.
earningType (enum EarningType) Earning Type.
See EarningType.
fiscalState (enum FiscalState) Fiscal State.
See FiscalState.
disabilityDegreeHolder (bool) Disability degree >= 60%.
earningHolders (int) Earning Holders.
secondHolderMajorEarning (bool) Sec. Holder Major Earning.
secondHolderDisabilityDegree (bool) Second Holder Disability degree >= 60%.
dependants (int) Dependants without disab. Degree.
disabilityDegreeDependents (int) Dependants w/ disab. Degree >= 60%.
taxResidence (enum TaxResidence) Tax Residence.
See TaxResidence.

The following elements are optional:

periodEnd (DateTime) End Period.
fixedTax (decimal) Fixed Tax.
taxJurisdictionService (string) Tax Jurisdiction Service.
disabilityFactor (int) Disability Factor.
mortgageLoanWithholdingRegime (enum MortgageLoanWithholdingRegime) Special withhold regime for mortgage loan holders.
See MortgageLoanWithholdingRegime.


TaxDataContractResource

The following elements are required:

contractKey (string) Contract.

The following elements are optional:

taxDataContractPeriods (List of TaxDataContractPeriodResource) Tax Data Contract Periods.
See TaxDataContractPeriodResource.
professionalStatus (string) Professional status.
irctApplicability (string) IRCT Applicability.
qualificationLevel (string) Qualification Level.
disabilityFunctionTax (decimal) Disability for function tax.
taxDataWorkingTimes (List of TaxDataWorkingTimeResource) Tax Data Working Times.
See TaxDataWorkingTimeResource.
economicActivityClassification (string) Economic Activity Classification.
(fk) Allowed value: the natural key of a record of type EconomicActivityClassification.
activityCode (string) Activity.
contractKind (enum ContractKind) Contract Kind.
See ContractKind.
taxRegionalArea (string) Tax Regional Area.
(fk) Allowed value: the natural key of a record of type TaxRegionalArea.


TaxDataWorkingTimeResource

The following elements are required:

periodStart (DateTime) Start Period.
duration (string) Duration.
organization (string) Organization.

The following elements are optional:

periodEnd (DateTime) End Period.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


ContractKind

1 Employment
2 Service


ContractState

1 NewContract
2 Active
3 Aborted
4 Outgoing
5 Finished


EarningType

1 PaidEmployment
2 Pensioner
3 BusinessAndProfessionalIncome


FiscalState

1 MarriedOrLifePartners
2 Others


HourlyWageFormula

1 Regular
2 FixedValue


MortgageLoanWithholdingRegime

1 BankCredit
2 Rent


TaxResidence

1 PTC
2 PTA
3 PTM
4 Nonresident


WorkTimeDuration

1 FullTime
2 PartTime