Portuguese Payroll | DMR

Service to manage entities of type 'DmrAt'.

Overview

api/{tenantKey}/{orgKey}/payrollPT/dmrAts

URL	api/{tenantKey}/{orgKey}/payrollPT/dmrAts
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:

ApiDmrAtDmrAtDetailsProcessingDetailsResource
ApiDmrAtDmrAtDetailsResource
ApiDmrAtDmrAtResumesResource
ApiDmrAtResource
DmrAtDetailResource
DmrAtMainDmrAtDetailsResource
DmrAtMainDmrAtResumesResource
DmrAtMainResource
DmrAtProcessingDetailResource
DmrAtResource
DmrAtResumeResource
MoneyResource

All Enumerations

This service uses the following enumerations:

DmrState
IncomeNature

GET Operations

GET DmrAts

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dmrAts

GET /payrollPT/dmrAts

GET DmrAts (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 DmrAtResource.

Response status codes:

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

Resource URL:

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

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

GET DmrAt 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 DmrAtResource.

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

GET /payrollPT/dmrAts/{id}

GET DmrAt by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
dmrKey	(string) DMR - AT.

Response:

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

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/dmrAts/{companyKey}/{dmrKey}

GET /payrollPT/dmrAts/{companyKey}/{dmrKey}

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

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

GET Print DmrAt by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
dmrKey	(string) DMR - AT.

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/dmrAts/{companyKey}/{dmrKey}/print

GET /payrollPT/dmrAts/{companyKey}/{dmrKey}/print

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

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

GET Original Print DmrAt by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
dmrKey	(string) DMR - AT.

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/dmrAts/{companyKey}/{dmrKey}/printOriginal

GET /payrollPT/dmrAts/{companyKey}/{dmrKey}/printOriginal

POST Operations

POST DmrAts

Creates a new entity record.

The following elements are required:

dmrAtResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dmrAts

POST /payrollPT/dmrAts

POST DMR

Inserts a new 'Dmr Summary' in the 'DMR'.

The following elements are required:

dmrKey	(string) DMR - AT.
companyKey	(string) The company key.
value	(ApiDmrAtDmrAtResumesResource) The ApiDmrAtDmrAtResumesResource instance. See ApiDmrAtDmrAtResumesResource.

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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes

POST /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes

POST DMR

Inserts a new 'DMR Detail' in the 'DMR'.

The following elements are required:

dmrKey	(string) DMR - AT.
companyKey	(string) The company key.
value	(ApiDmrAtDmrAtDetailsResource) The ApiDmrAtDmrAtDetailsResource instance. See ApiDmrAtDmrAtDetailsResource.

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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails

POST /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails

POST Generate Dmr At

Custom operation 'GenerateDmrAt'.

The following elements are required:

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

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dmrAts/generateDmrAt/{companyKey}/{month}/{year}

POST /payrollPT/dmrAts/generateDmrAt/{companyKey}/{month}/{year}

PUT Operations

PUT Set Company DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/company

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/company

PUT Set CompulsoryContributions DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/compulsoryContributions

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/compulsoryContributions

PUT Set CompulsoryContributions DmrAtResume

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/compulsoryContributions

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/compulsoryContributions

PUT Set Currency DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/currency

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/currency

PUT Set Currency DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/currency

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/currency

PUT Set Currency DmrAtResume

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/currency

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/currency

PUT Set DeliveryDate DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/deliveryDate

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/deliveryDate

PUT Set Description DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/description

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/description

PUT Set DmrKey DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrKey

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrKey

PUT Set DmrState DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrState

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrState

PUT Set DummyValue DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dummyValue

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dummyValue

PUT Set Employee DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/employee

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/employee

PUT Set ImpedimentDate DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/impedimentDate

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/impedimentDate

PUT Set ImpedimentEndDate DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/impedimentEndDate

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/impedimentEndDate

PUT Set ImpedimentReason DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/impedimentReason

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/impedimentReason

PUT Set IncomeNature DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum IncomeNature) The request body should contain the new value for the attribute. See IncomeNature.

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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/incomeNature

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/incomeNature

PUT Set IncomeNature DmrAtResume

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

The following elements are required:

dmrKey	(string) DMR - AT.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum IncomeNature) The request body should contain the new value for the attribute. See IncomeNature.

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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/incomeNature

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/incomeNature

PUT Set IncomeType DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/incomeType

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/incomeType

PUT Set IncomeValues DmrAtResume

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/incomeValues

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/incomeValues

PUT Set IsActive DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/isActive

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/isActive

PUT Set IsCalculated DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/isCalculated

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/isCalculated

PUT Set IsModified DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/isModified

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/isModified

PUT Set LocalOBT DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/localOBT

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/localOBT

PUT Set NIPC1 DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/nIPC1

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/nIPC1

PUT Set NIPC2 DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/nIPC2

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/nIPC2

PUT Set NIPC3 DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/nIPC3

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/nIPC3

PUT Set Period DmrAt

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/period

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/period

PUT Set SubscriberId DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/subscriberId

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/subscriberId

PUT Set UnionFees DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/unionFees

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/unionFees

PUT Set UnionFees DmrAtResume

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/unionFees

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/unionFees

PUT Set WithholdingTax DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/withholdingTax

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/withholdingTax

PUT Set WithholdingTax DmrAtResume

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/withholdingTax

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}/withholdingTax

PUT Set Year DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/year

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/year

PUT Set YearIncome DmrAtDetail

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

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/yearIncome

PUT /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}/yearIncome

DELETE Operations

DELETE Dmr Summary by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}

DELETE /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtResumes/{lineId}

DELETE DMR Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dmrKey	(string) DMR - AT.
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/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}

DELETE /payrollPT/dmrAts/{companyKey}/{dmrKey}/dmrAtDetails/{lineId}

DELETE DmrAt 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/dmrAts/{id}

DELETE /payrollPT/dmrAts/{id}

DELETE DmrAt by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
dmrKey	(string) DMR - AT.

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/dmrAts/{companyKey}/{dmrKey}

DELETE /payrollPT/dmrAts/{companyKey}/{dmrKey}

Resources

ApiDmrAtDmrAtDetailsProcessingDetailsResource

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.

ApiDmrAtDmrAtDetailsResource

The following elements are required:

employee	(string) Employee.
year	(int) Year.
yearIncome	(MoneyResource) Year Income. See MoneyResource .
incomeNature	(enum IncomeNature) Nature. See IncomeNature.
localOBT	(string) Local OBT.
withholdingTax	(MoneyResource) Withholding Tax. See MoneyResource .
compulsoryContributions	(MoneyResource) Compulsory Contributions. See MoneyResource .
unionFees	(MoneyResource) Union Fees. See MoneyResource .
currency	(string) Currency.
isCalculated	(bool) Is Calculated.
isModified	(bool) Modified.

The following elements are optional:

subscriberId	(string) Subscriber Id.
incomeType	(string) Income Type.
nIPC1	(string) NIPC1.
nIPC2	(string) NIPC2.
nIPC3	(string) NIPC3.
processingDetails	(List of ApiDmrAtDmrAtDetailsProcessingDetailsResource) Processing Details. See ApiDmrAtDmrAtDetailsProcessingDetailsResource.

ApiDmrAtDmrAtResumesResource

The following elements are required:

incomeValues	(MoneyResource) Income Values. See MoneyResource .
withholdingTax	(MoneyResource) Withholding Tax. See MoneyResource .
compulsoryContributions	(MoneyResource) Compulsory Contributions. See MoneyResource .
unionFees	(MoneyResource) Union Fees. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

incomeNature

(enum IncomeNature) Income Nature.
See IncomeNature.

ApiDmrAtResource

The following elements are required:

dmrKey	(string) DMR - AT.
period	(DateTime) Period.
dmrState	(enum DmrState) State. See DmrState.
currency	(string) Currency.
company	(string) Company.
dummyValue	(MoneyResource) Propriedade gerada por causa da implementação do IMonetaryData. See MoneyResource .

The following elements are optional:

description	(string) Description.
dmrAtResumes	(List of ApiDmrAtDmrAtResumesResource) Dmr At Resumes. See ApiDmrAtDmrAtResumesResource.
dmrAtDetails	(List of ApiDmrAtDmrAtDetailsResource) Dmr At Details. See ApiDmrAtDmrAtDetailsResource.
deliveryDate	(DateTime) Delivery Date.
impedimentReason	(string) Impediment Reason.
impedimentDate	(DateTime) Impediment Date.
impedimentEndDate	(DateTime) Impediment End Date.

DmrAtDetailResource

The following elements are required:

employee	(string) Employee.
year	(int) Year.
yearIncome	(MoneyResource) Year Income. See MoneyResource .
incomeNature	(enum IncomeNature) Nature. See IncomeNature.
localOBT	(string) Local OBT.
withholdingTax	(MoneyResource) Withholding Tax. See MoneyResource .
compulsoryContributions	(MoneyResource) Compulsory Contributions. See MoneyResource .
unionFees	(MoneyResource) Union Fees. See MoneyResource .
currency	(string) Currency.
isCalculated	(bool) Is Calculated.
isModified	(bool) Modified.

The following elements are optional:

subscriberId	(string) Subscriber Id.
incomeType	(string) Income Type.
nIPC1	(string) NIPC1.
nIPC2	(string) NIPC2.
nIPC3	(string) NIPC3.
processingDetails	(List of DmrAtProcessingDetailResource) Processing Details. See DmrAtProcessingDetailResource.

DmrAtMainDmrAtDetailsResource

The following elements are required:

compulsoryContributions	(MoneyResource) Compulsory Contributions. See MoneyResource .
employee	(string) Employee.
incomeNature	(enum IncomeNature) Nature. See IncomeNature.
isCalculated	(bool) Is Calculated.
localOBT	(string) Local OBT.
unionFees	(MoneyResource) Union Fees. See MoneyResource .
withholdingTax	(MoneyResource) Withholding Tax. See MoneyResource .
year	(int) Year.
yearIncome	(MoneyResource) Year Income. See MoneyResource .
currency	(string) Currency.
isModified	(bool) Modified.

The following elements are optional:

incomeType	(string) Income Type.
nIPC1	(string) NIPC1.
nIPC2	(string) NIPC2.
nIPC3	(string) NIPC3.
subscriberId	(string) Subscriber Id.

DmrAtMainDmrAtResumesResource

The following elements are required:

compulsoryContributions	(MoneyResource) Compulsory Contributions. See MoneyResource .
incomeValues	(MoneyResource) Income Values. See MoneyResource .
unionFees	(MoneyResource) Union Fees. See MoneyResource .
withholdingTax	(MoneyResource) Withholding Tax. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

incomeNature

(enum IncomeNature) Income Nature.
See IncomeNature.

DmrAtMainResource

The following elements are required:

dmrKey	(string) DMR - AT.
dmrState	(enum DmrState) State. See DmrState.
period	(DateTime) Period.
company	(string) Company.
currency	(string) Currency.

The following elements are optional:

description	(string) Description.
dmrAtDetails	(List of DmrAtMainDmrAtDetailsResource) Dmr At Details. See DmrAtMainDmrAtDetailsResource.
dmrAtResumes	(List of DmrAtMainDmrAtResumesResource) Dmr At Resumes. See DmrAtMainDmrAtResumesResource.
deliveryDate	(DateTime) Delivery Date.
impedimentDate	(DateTime) Impediment Date.
impedimentReason	(string) Impediment Reason.
impedimentEndDate	(DateTime) Impediment End Date.

DmrAtProcessingDetailResource

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.

DmrAtResource

The following elements are required:

dmrKey	(string) DMR - AT.
period	(DateTime) Period.
dmrState	(enum DmrState) State. See DmrState.
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
dummyValue	(MoneyResource) Propriedade gerada por causa da implementação do IMonetaryData. See MoneyResource .

The following elements are optional:

description	(string) Description.
dmrAtResumes	(List of DmrAtResumeResource) Dmr At Resumes. See DmrAtResumeResource.
dmrAtDetails	(List of DmrAtDetailResource) Dmr At Details. See DmrAtDetailResource.
deliveryDate	(DateTime) Delivery Date.
impedimentReason	(string) Impediment Reason. (fk) Allowed value: the natural key of a record of type DmrAtImpedimentReason. These records are accessibly through the DmrAtImpedimentReasons service.
impedimentDate	(DateTime) Impediment Date.
impedimentEndDate	(DateTime) Impediment End Date.

DmrAtResumeResource

The following elements are required:

incomeValues	(MoneyResource) Income Values. See MoneyResource .
withholdingTax	(MoneyResource) Withholding Tax. See MoneyResource .
compulsoryContributions	(MoneyResource) Compulsory Contributions. See MoneyResource .
unionFees	(MoneyResource) Union Fees. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

incomeNature

(enum IncomeNature) Income Nature.
See IncomeNature.

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

IncomeNature

1	SubjectIncomes
2	FreeIncomes
3	ExemptIncomes