Portuguese Payroll | Configuration Module

Service to manage entities of type 'ConfigurationModule'.

Overview

api/{tenantKey}/{orgKey}/payrollPT/configurationModules

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

All Operations

This service includes the following operations:

GET:
PUT:
POST:
DELETE:

All Resources

This service uses the following resources:

ApiConfigurationModuleConfigurationEntityInsurersResource
ApiConfigurationModuleConfigurationEntitySyndicatesResource
ApiConfigurationModuleHiringReasonsClassificationsResource
ApiConfigurationModuleResource
ConfigurationEntityInsurerResource
ConfigurationEntitySyndicateResource
ConfigurationModuleResource
HiringReasonsClassificationResource

GET Operations

GET ConfigurationModules

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules

GET /payrollPT/configurationModules

GET ConfigurationModules (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 ConfigurationModuleResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules?page={page}&pageSize={pageSize}

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

GET ConfigurationModule 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 ConfigurationModuleResource.

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

GET /payrollPT/configurationModules/{id}

GET ConfigurationModule by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) Company.

Response:

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

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}/payrollPT/configurationModules/{company}

GET /payrollPT/configurationModules/{company}

GET Print ConfigurationModule 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:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules/{id}/print?template={template}

GET /payrollPT/configurationModules/{id}/print?template={template}

GET Print ConfigurationModule by key

Prints the specified entity record.

The following elements are required:

company

(string) Company.

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:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules/{company}/print

GET /payrollPT/configurationModules/{company}/print

GET Original Print ConfigurationModuleOriginal 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:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules/{id}/printOriginal?template={template}

GET /payrollPT/configurationModules/{id}/printOriginal?template={template}

GET Original Print ConfigurationModule by key

Prints the specified entity record.

The following elements are required:

company

(string) Company.

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:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules/{company}/printOriginal

GET /payrollPT/configurationModules/{company}/printOriginal

POST Operations

POST Configuration Module

Inserts a new 'Configuration Entity Syndicate' in the 'Configuration Module'.

The following elements are required:

company	(string) Company.
value	(ApiConfigurationModuleConfigurationEntitySyndicatesResource) The ApiConfigurationModuleConfigurationEntitySyndicatesResource instance. See ApiConfigurationModuleConfigurationEntitySyndicatesResource.

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}/payrollPT/configurationModules/{company}/configurationEntitySyndicates

POST /payrollPT/configurationModules/{company}/configurationEntitySyndicates

POST Configuration Module

Inserts a new 'Configuration Entity Insurer' in the 'Configuration Module'.

The following elements are required:

company	(string) Company.
value	(ApiConfigurationModuleConfigurationEntityInsurersResource) The ApiConfigurationModuleConfigurationEntityInsurersResource instance. See ApiConfigurationModuleConfigurationEntityInsurersResource.

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}/payrollPT/configurationModules/{company}/configurationEntityInsurers

POST /payrollPT/configurationModules/{company}/configurationEntityInsurers

POST Configuration Module

Inserts a new 'Hiring Reasons Classification' in the 'Configuration Module'.

The following elements are required:

company	(string) Company.
value	(ApiConfigurationModuleHiringReasonsClassificationsResource) The ApiConfigurationModuleHiringReasonsClassificationsResource instance. See ApiConfigurationModuleHiringReasonsClassificationsResource.

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}/payrollPT/configurationModules/{company}/hiringReasonsClassifications

POST /payrollPT/configurationModules/{company}/hiringReasonsClassifications

PUT Operations

PUT Set AtLegalRepresentativeId ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/atLegalRepresentativeId

PUT /payrollPT/configurationModules/{company}/atLegalRepresentativeId

PUT Set AtParty ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/atParty

PUT /payrollPT/configurationModules/{company}/atParty

PUT Set AtTaxJurisdictionService ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/atTaxJurisdictionService

PUT /payrollPT/configurationModules/{company}/atTaxJurisdictionService

PUT Set AtTechnicalAccountantId ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/atTechnicalAccountantId

PUT /payrollPT/configurationModules/{company}/atTechnicalAccountantId

PUT Set Company ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/company

PUT /payrollPT/configurationModules/{company}/company

PUT Set EmployersAssociationCode ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/employersAssociationCode

PUT /payrollPT/configurationModules/{company}/employersAssociationCode

PUT Set EstablishmentDate ConfigurationModule

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

The following elements are required:

company	(string) Company.
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:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules/{company}/establishmentDate

PUT /payrollPT/configurationModules/{company}/establishmentDate

PUT Set ForeignPercentage ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/foreignPercentage

PUT /payrollPT/configurationModules/{company}/foreignPercentage

PUT Set GLAccountCharge ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/gLAccountCharge

PUT /payrollPT/configurationModules/{company}/gLAccountCharge

PUT Set GLAccountEmployer ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/gLAccountEmployer

PUT /payrollPT/configurationModules/{company}/gLAccountEmployer

PUT Set HiringReason HiringReasonsClassification

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/hiringReasonsClassifications/{lineId}/hiringReason

PUT /payrollPT/configurationModules/{company}/hiringReasonsClassifications/{lineId}/hiringReason

PUT Set IncludeZeroLines ConfigurationEntityInsurer

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

The following elements are required:

company	(string) Company.
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:

api/{tenantKey}/{orgKey}/payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/includeZeroLines

PUT /payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/includeZeroLines

PUT Set IsActive ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/isActive

PUT /payrollPT/configurationModules/{company}/isActive

PUT Set JournalType ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/journalType

PUT /payrollPT/configurationModules/{company}/journalType

PUT Set LegalNature ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/legalNature

PUT /payrollPT/configurationModules/{company}/legalNature

PUT Set NationalPrivatePercentage ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/nationalPrivatePercentage

PUT /payrollPT/configurationModules/{company}/nationalPrivatePercentage

PUT Set NationalPublicPercentage ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/nationalPublicPercentage

PUT /payrollPT/configurationModules/{company}/nationalPublicPercentage

PUT Set Party ConfigurationEntityInsurer

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/party

PUT /payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/party

PUT Set Party ConfigurationEntitySyndicate

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/configurationEntitySyndicates/{lineId}/party

PUT /payrollPT/configurationModules/{company}/configurationEntitySyndicates/{lineId}/party

PUT Set PlatformAccessInteroperability ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/platformAccessInteroperability

PUT /payrollPT/configurationModules/{company}/platformAccessInteroperability

PUT Set SEGCode ConfigurationEntityInsurer

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/sEGCode

PUT /payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/sEGCode

PUT Set SegSocialCode HiringReasonsClassification

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/hiringReasonsClassifications/{lineId}/segSocialCode

PUT /payrollPT/configurationModules/{company}/hiringReasonsClassifications/{lineId}/segSocialCode

PUT Set SegSocParty ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/segSocParty

PUT /payrollPT/configurationModules/{company}/segSocParty

PUT Set SegSocPaymentMethod ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/segSocPaymentMethod

PUT /payrollPT/configurationModules/{company}/segSocPaymentMethod

PUT Set SegSocPaymentTerm ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/segSocPaymentTerm

PUT /payrollPT/configurationModules/{company}/segSocPaymentTerm

PUT Set SingleReportCode ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/singleReportCode

PUT /payrollPT/configurationModules/{company}/singleReportCode

PUT Set SubscriberType ConfigurationEntityInsurer

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/subscriberType

PUT /payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}/subscriberType

PUT Set SubscriberType ConfigurationEntitySyndicate

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/configurationEntitySyndicates/{lineId}/subscriberType

PUT /payrollPT/configurationModules/{company}/configurationEntitySyndicates/{lineId}/subscriberType

PUT Set TaxReportSetupId ConfigurationModule

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

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/taxReportSetupId

PUT /payrollPT/configurationModules/{company}/taxReportSetupId

DELETE Operations

DELETE Configuration Entity Syndicate by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/configurationEntitySyndicates/{lineId}

DELETE /payrollPT/configurationModules/{company}/configurationEntitySyndicates/{lineId}

DELETE Configuration Entity Insurer by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}

DELETE /payrollPT/configurationModules/{company}/configurationEntityInsurers/{lineId}

DELETE Hiring Reasons Classification by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company	(string) Company.
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}/payrollPT/configurationModules/{company}/hiringReasonsClassifications/{lineId}

DELETE /payrollPT/configurationModules/{company}/hiringReasonsClassifications/{lineId}

Resources

ApiConfigurationModuleConfigurationEntityInsurersResource

The following elements are required:

party	(string) Party.
sEGCode	(string) SEG.
subscriberType	(string) Subscriber Type.

The following elements are optional:

includeZeroLines

(bool) Include Zero Lines.

ApiConfigurationModuleConfigurationEntitySyndicatesResource

The following elements are required:

party

(string) Party.

The following elements are optional:

subscriberType

(string) Subscriber Type.

ApiConfigurationModuleHiringReasonsClassificationsResource

The following elements are required:

hiringReason

(string) Hiring Reason.

The following elements are optional:

segSocialCode

(string) Seg Social.

ApiConfigurationModuleResource

The following elements are required:

company

(string) Company.

The following elements are optional:

configurationEntitySyndicates	(List of ApiConfigurationModuleConfigurationEntitySyndicatesResource) Configuration Entity Syndicates. See ApiConfigurationModuleConfigurationEntitySyndicatesResource.
configurationEntityInsurers	(List of ApiConfigurationModuleConfigurationEntityInsurersResource) Configuration Entity Insurers. See ApiConfigurationModuleConfigurationEntityInsurersResource.
gLAccountEmployer	(string) GL Account Employer.
gLAccountCharge	(string) GL Account Charge.
journalType	(string) Journal Type.
atParty	(string) Party.
atTaxJurisdictionService	(string) Tax Jurisdiction Service.
segSocParty	(string) Party.
segSocPaymentMethod	(string) Payment Method.
segSocPaymentTerm	(string) Payment Term.
hiringReasonsClassifications	(List of ApiConfigurationModuleHiringReasonsClassificationsResource) Hiring Reasons Classifications. See ApiConfigurationModuleHiringReasonsClassificationsResource.
legalNature	(string) Legal Nature.
establishmentDate	(DateTime) Establishment Date.
nationalPrivatePercentage	(decimal) National Private.
nationalPublicPercentage	(decimal) National Public.
foreignPercentage	(decimal) Foreign.
platformAccessInteroperability	(string) The password of the login that allows the user to communicate with the Seguranca Social.
employersAssociationCode	(string) Employers association code to fill in Single Report (4digits).
taxReportSetupId	(string) Tax Report to fill in Single Report.
singleReportCode	(string) Single Report Code.
atLegalRepresentativeId	(string) The Tax id of the Legal Representative.
atTechnicalAccountantId	(string) The Tax id of Technical account.

ConfigurationEntityInsurerResource

The following elements are required:

party	(string) Party.
sEGCode	(string) SEG.
subscriberType	(string) Subscriber Type.

The following elements are optional:

includeZeroLines

(bool) Include Zero Lines.

ConfigurationEntitySyndicateResource

The following elements are required:

party

(string) Party.

The following elements are optional:

subscriberType

(string) Subscriber Type.

ConfigurationModuleResource

The following elements are required:

company

(string) Company.
(fk) Allowed value: the natural key of a record of type Company.

The following elements are optional:

configurationEntitySyndicates	(List of ConfigurationEntitySyndicateResource) Configuration Entity Syndicates. See ConfigurationEntitySyndicateResource.
configurationEntityInsurers	(List of ConfigurationEntityInsurerResource) Configuration Entity Insurers. See ConfigurationEntityInsurerResource.
gLAccountEmployer	(string) GL Account Employer. (fk) Allowed value: the natural key of a record of type GLAccount.
gLAccountCharge	(string) GL Account Charge. (fk) Allowed value: the natural key of a record of type GLAccount.
chartOfAccount	(string) Chart Of Account. (fk) Allowed value: the natural key of a record of type ChartOfAccount.
journalType	(string) Journal Type. (fk) Allowed value: the natural key of a record of type JournalType.
atParty	(string) Party. (fk) Allowed value: the natural key of a record of type Party.
atTaxJurisdictionService	(string) Tax Jurisdiction Service.
segSocParty	(string) Party. (fk) Allowed value: the natural key of a record of type Party.
segSocPaymentMethod	(string) Payment Method. (fk) Allowed value: the natural key of a record of type PaymentMethod.
segSocPaymentTerm	(string) Payment Term. (fk) Allowed value: the natural key of a record of type PaymentTerm.
hiringReasonsClassifications	(List of HiringReasonsClassificationResource) Hiring Reasons Classifications. See HiringReasonsClassificationResource.
legalNature	(string) Legal Nature.
establishmentDate	(DateTime) Establishment Date.
nationalPrivatePercentage	(decimal) National Private.
nationalPublicPercentage	(decimal) National Public.
foreignPercentage	(decimal) Foreign.
platformAccessInteroperability	(string) The password of the login that allows the user to communicate with the Seguranca Social.
employersAssociationCode	(string) Employers association code to fill in Single Report (4digits).
taxReportSetupId	(string) Tax Report to fill in Single Report.
singleReportCode	(string) Single Report Code.
atLegalRepresentativeId	(string) The Tax id of the Legal Representative.
atTechnicalAccountantId	(string) The Tax id of Technical account.

HiringReasonsClassificationResource

The following elements are required:

hiringReason

(string) Hiring Reason.

The following elements are optional:

segSocialCode

(string) Seg Social.