Portuguese Payroll | DR Insurer

Service to manage entities of type 'DRInsurer'.

Overview

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiDRInsurerDRInsurerDetailsProcessingDetailsResource
ApiDRInsurerDRInsurerDetailsResource
ApiDRInsurerFilesResource
ApiDRInsurerResource
ApiDRInsurerResumesResource
DRInsurerDetailResource
DRInsurerFileResource
DRInsurerMainDRInsurerDetailsResource
DRInsurerMainResource
DRInsurerMainResumesResource
DRInsurerProcessingDetailResource
DRInsurerResource
DRInsurerResumeResource
MoneyResource

All Enumerations

This service uses the following enumerations:

DmrState

GET Operations

GET DRInsurers

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers

GET /payrollPT/dRInsurers

GET DRInsurers (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 DRInsurerResource.

Response status codes:

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

Resource URL:

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

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

GET DRInsurer 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 DRInsurerResource.

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

GET /payrollPT/dRInsurers/{id}

GET DRInsurer by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
dRInsurerKey	(string) DR Insurer.

Response:

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

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/dRInsurers/{companyKey}/{dRInsurerKey}

GET /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}

GET Print DRInsurer 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/dRInsurers/{id}/print?template={template}

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

GET Print DRInsurer by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
dRInsurerKey	(string) DR Insurer.

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/dRInsurers/{companyKey}/{dRInsurerKey}/print

GET /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/print

GET Original Print DRInsurerOriginal 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/dRInsurers/{id}/printOriginal?template={template}

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

GET Original Print DRInsurer by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
dRInsurerKey	(string) DR Insurer.

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/dRInsurers/{companyKey}/{dRInsurerKey}/printOriginal

GET /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/printOriginal

POST Operations

POST DRInsurers

Creates a new entity record.

The following elements are required:

dRInsurerResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers

POST /payrollPT/dRInsurers

POST DR Insurer

Inserts a new 'DR Insurer Detail' in the 'DR Insurer'.

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(ApiDRInsurerDRInsurerDetailsResource) The ApiDRInsurerDRInsurerDetailsResource instance. See ApiDRInsurerDRInsurerDetailsResource.

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/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails

POST /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails

POST DR Insurer

Inserts a new 'DR Insurer Resume' in the 'DR Insurer'.

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(ApiDRInsurerResumesResource) The ApiDRInsurerResumesResource instance. See ApiDRInsurerResumesResource.

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/dRInsurers/{companyKey}/{dRInsurerKey}/resumes

POST /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes

POST DR Insurer

Inserts a new 'DR Insurer File' in the 'DR Insurer'.

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(ApiDRInsurerFilesResource) The ApiDRInsurerFilesResource instance. See ApiDRInsurerFilesResource.

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/dRInsurers/{companyKey}/{dRInsurerKey}/files

POST /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/files

POST Generate DR Insurer

Custom operation 'GenerateDRInsurer'.

The following elements are required:

companyKey	(string) CompanyKey.
month	(int) Month.
year	(int) Year.
deduction	(string) Deduction.
generateWithNoRows	(bool) GenerateWithNoRows.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/generateDRInsurer/{companyKey}/{month}/{year}

POST /payrollPT/dRInsurers/generateDRInsurer/{companyKey}/{month}/{year}

PUT Operations

PUT Set ClassificationType DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/classificationType

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/classificationType

PUT Set Company DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/company

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/company

PUT Set ContributionValue DRInsurerResume

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/contributionValue

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/contributionValue

PUT Set Currency DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/currency

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/currency

PUT Set Currency DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/currency

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/currency

PUT Set Currency DRInsurerResume

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/currency

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/currency

PUT Set Days DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/days

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/days

PUT Set Deduction DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/deduction

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/deduction

PUT Set DeliveryDate DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/deliveryDate

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/deliveryDate

PUT Set Description DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/description

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/description

PUT Set DRInsurerKey DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerKey

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerKey

PUT Set DRInsurerState DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(enum DmrState) The request body should contain the new value for the attribute. See DmrState.

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/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerState

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerState

PUT Set Earnings DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/earnings

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/earnings

PUT Set EarningValue DRInsurerResume

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/earningValue

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/earningValue

PUT Set Employee DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/employee

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/employee

PUT Set FileId DRInsurerFile

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/files/{lineId}/fileId

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/files/{lineId}/fileId

PUT Set IncludeZeroLines DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/includeZeroLines

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/includeZeroLines

PUT Set IsActive DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/isActive

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/isActive

PUT Set IsCalculated DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/isCalculated

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/isCalculated

PUT Set IsModified DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/isModified

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/isModified

PUT Set Nature DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/nature

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/nature

PUT Set Period DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/period

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/period

PUT Set Period DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/period

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/period

PUT Set Policy DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/policy

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/policy

PUT Set Signal DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/signal

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/signal

PUT Set SubscriberId DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/subscriberId

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/subscriberId

PUT Set Tax DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/tax

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/tax

PUT Set Tax DRInsurerResume

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/tax

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/tax

PUT Set TotalEarnings DRInsurer

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/totalEarnings

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/totalEarnings

PUT Set WorkLocation DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/workLocation

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/workLocation

PUT Set WorkLocation DRInsurerResume

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/workLocation

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/workLocation

PUT Set WorkLocationNISS DRInsurerDetail

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/workLocationNISS

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}/workLocationNISS

PUT Set WorkLocationNISS DRInsurerFile

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/files/{lineId}/workLocationNISS

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/files/{lineId}/workLocationNISS

PUT Set WorkLocationNISS DRInsurerResume

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

The following elements are required:

dRInsurerKey	(string) DR Insurer.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/workLocationNISS

PUT /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}/workLocationNISS

DELETE Operations

DELETE DR Insurer Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}

DELETE /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/dRInsurerDetails/{lineId}

DELETE DR Insurer Resume by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}

DELETE /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/resumes/{lineId}

DELETE DR Insurer File by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dRInsurerKey	(string) DR Insurer.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/files/{lineId}

DELETE /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}/files/{lineId}

DELETE DRInsurer 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}/payrollPT/dRInsurers/{id}

DELETE /payrollPT/dRInsurers/{id}

DELETE DRInsurer by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
dRInsurerKey	(string) DR Insurer.

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}/payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}

DELETE /payrollPT/dRInsurers/{companyKey}/{dRInsurerKey}

Resources

ApiDRInsurerDRInsurerDetailsProcessingDetailsResource

The following elements are required:

processing	(string) Processing.
earning	(string) Earning.
subjectValue	(MoneyResource) Subject Value. See MoneyResource .
exemptValue	(MoneyResource) Exempt Value. See MoneyResource .
freeValue	(MoneyResource) Free Value. See MoneyResource .
currency	(string) Currency.

ApiDRInsurerDRInsurerDetailsResource

The following elements are required:

employee	(string) Employee.
subscriberId	(string) Subscriber Id.
workLocation	(string) Work Location.
tax	(decimal) Tax.
period	(string) Period.
earnings	(MoneyResource) Earnings. See MoneyResource .
nature	(string) Nature.
currency	(string) Currency.
isCalculated	(bool) Is Calculated.
isModified	(bool) Modified.

The following elements are optional:

workLocationNISS	(string) Work Location NISS.
days	(decimal) Days.
signal	(string) Signal.
classificationType	(string) Classification Type.
processingDetails	(List of ApiDRInsurerDRInsurerDetailsProcessingDetailsResource) Processing Details. See ApiDRInsurerDRInsurerDetailsProcessingDetailsResource.
includeZeroLines	(bool) Include Zero Lines.

ApiDRInsurerFilesResource

The following elements are required:

workLocationNISS	(string) Work Location NISS.
fileId	(Guid) File Id.

ApiDRInsurerResource

The following elements are required:

dRInsurerKey	(string) DR Insurer.
deduction	(string) Deduction.
period	(DateTime) Period.
dRInsurerState	(enum DmrState) State. See DmrState.
company	(string) Company.
currency	(string) Currency.
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .

The following elements are optional:

policy	(string) Policy.
description	(string) Description.
deliveryDate	(DateTime) Delivery Date.
dRInsurerDetails	(List of ApiDRInsurerDRInsurerDetailsResource) DR Insurer Details. See ApiDRInsurerDRInsurerDetailsResource.
resumes	(List of ApiDRInsurerResumesResource) Resumes. See ApiDRInsurerResumesResource.
files	(List of ApiDRInsurerFilesResource) Files. See ApiDRInsurerFilesResource.

ApiDRInsurerResumesResource

The following elements are required:

earningValue	(MoneyResource) Earning Value. See MoneyResource .
contributionValue	(MoneyResource) Contribution Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

workLocation	(string) Work Location.
tax	(decimal) Tax.
workLocationNISS	(string) Work Location NISS.

DRInsurerDetailResource

The following elements are required:

employee	(string) Employee.
subscriberId	(string) Subscriber Id.
workLocation	(string) Work Location.
tax	(decimal) Tax.
period	(string) Period.
earnings	(MoneyResource) Earnings. See MoneyResource .
nature	(string) Nature.
currency	(string) Currency.
isCalculated	(bool) Is Calculated.
isModified	(bool) Modified.

The following elements are optional:

workLocationNISS	(string) Work Location NISS.
days	(decimal) Days.
signal	(string) Signal.
classificationType	(string) Classification Type.
processingDetails	(List of DRInsurerProcessingDetailResource) Processing Details. See DRInsurerProcessingDetailResource.
includeZeroLines	(bool) Include Zero Lines.

DRInsurerFileResource

The following elements are required:

workLocationNISS	(string) Work Location NISS.
fileId	(Guid) File Id.

DRInsurerMainDRInsurerDetailsResource

The following elements are required:

currency	(string) Currency.
earnings	(MoneyResource) Earnings. See MoneyResource .
employee	(string) Employee.
isCalculated	(bool) Is Calculated.
nature	(string) Nature.
period	(string) Period.
subscriberId	(string) Subscriber Id.
tax	(decimal) Tax.
workLocation	(string) Work Location.
isModified	(bool) Modified.

The following elements are optional:

days	(decimal) Days.
signal	(string) Signal.
workLocationNISS	(string) Work Location NISS.

DRInsurerMainResource

The following elements are required:

company	(string) Company.
currency	(string) Currency.
deduction	(string) Deduction.
dRInsurerKey	(string) DR Insurer.
dRInsurerState	(enum DmrState) State. See DmrState.
period	(DateTime) Period.
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .

The following elements are optional:

deliveryDate	(DateTime) Delivery Date.
description	(string) Description.
dRInsurerDetails	(List of DRInsurerMainDRInsurerDetailsResource) DR Insurer Details. See DRInsurerMainDRInsurerDetailsResource.
party	(string) Party.
policy	(string) Policy.
resumes	(List of DRInsurerMainResumesResource) Resumes. See DRInsurerMainResumesResource.

DRInsurerMainResumesResource

The following elements are required:

contributionValue	(MoneyResource) Contribution Value. See MoneyResource .
currency	(string) Currency.
earningValue	(MoneyResource) Earning Value. See MoneyResource .

The following elements are optional:

tax	(decimal) Tax.
workLocation	(string) Work Location.
workLocationNISS	(string) Work Location NISS.

DRInsurerProcessingDetailResource

The following elements are required:

processing	(string) Processing.
earning	(string) Earning.
subjectValue	(MoneyResource) Subject Value. See MoneyResource .
exemptValue	(MoneyResource) Exempt Value. See MoneyResource .
freeValue	(MoneyResource) Free Value. See MoneyResource .
currency	(string) Currency.

DRInsurerResource

The following elements are required:

dRInsurerKey	(string) DR Insurer.
deduction	(string) Deduction. (fk) Allowed value: the natural key of a record of type Deduction. These records are accessibly through the Deductions service.
period	(DateTime) Period.
dRInsurerState	(enum DmrState) State. See DmrState.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency.
totalEarnings	(MoneyResource) Total Earnings. See MoneyResource .

The following elements are optional:

party	(string) Party. (fk) Allowed value: the natural key of a record of type Party.
policy	(string) Policy.
description	(string) Description.
deliveryDate	(DateTime) Delivery Date.
dRInsurerDetails	(List of DRInsurerDetailResource) DR Insurer Details. See DRInsurerDetailResource.
resumes	(List of DRInsurerResumeResource) Resumes. See DRInsurerResumeResource.
files	(List of DRInsurerFileResource) Files. See DRInsurerFileResource.

DRInsurerResumeResource

The following elements are required:

earningValue	(MoneyResource) Earning Value. See MoneyResource .
contributionValue	(MoneyResource) Contribution Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

workLocation	(string) Work Location.
tax	(decimal) Tax.
workLocationNISS	(string) Work Location NISS.

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.

Enumerations

DmrState

1	Processed
2	Exported
3	Sent
4	Failed