Portuguese Payroll | DRi

Service to manage entities of type 'DRi'.

Overview

api/{tenantKey}/{orgKey}/payrollPT/dRis

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

ApiDRiDRiDetailsProcessingDetailsResource
ApiDRiDRiDetailsResource
ApiDRiDRiResumesResource
ApiDRiResource
DRiDetailResource
DriMainDRiDetailsResource
DriMainDRiResumesResource
DriMainResource
DRiProcessingDetailResource
DRiResource
DRiResumeResource
MoneyResource

All Enumerations

This service uses the following enumerations:

DriState

GET Operations

GET DRis

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRis

GET /payrollPT/dRis

GET DRis (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 DRiResource.

Response status codes:

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

Resource URL:

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

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

GET DRi 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 DRiResource.

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

GET /payrollPT/dRis/{id}

GET DRi by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
dRiKey	(string) DRi.

Response:

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

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/dRis/{companyKey}/{dRiKey}

GET /payrollPT/dRis/{companyKey}/{dRiKey}

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

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

GET Print DRi by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
dRiKey	(string) DRi.

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/dRis/{companyKey}/{dRiKey}/print

GET /payrollPT/dRis/{companyKey}/{dRiKey}/print

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

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

GET Original Print DRi by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
dRiKey	(string) DRi.

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/dRis/{companyKey}/{dRiKey}/printOriginal

GET /payrollPT/dRis/{companyKey}/{dRiKey}/printOriginal

POST Operations

POST DRis

Creates a new entity record.

The following elements are required:

dRiResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRis

POST /payrollPT/dRis

POST DRi

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

The following elements are required:

dRiKey	(string) DRi.
companyKey	(string) The company key.
value	(ApiDRiDRiDetailsResource) The ApiDRiDRiDetailsResource instance. See ApiDRiDRiDetailsResource.

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/dRis/{companyKey}/{dRiKey}/dRiDetails

POST /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails

POST DRi

Inserts a new 'D Ri Resume' in the 'DRi'.

The following elements are required:

dRiKey	(string) DRi.
companyKey	(string) The company key.
value	(ApiDRiDRiResumesResource) The ApiDRiDRiResumesResource instance. See ApiDRiDRiResumesResource.

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/dRis/{companyKey}/{dRiKey}/dRiResumes

POST /payrollPT/dRis/{companyKey}/{dRiKey}/dRiResumes

POST Generate Dri

Custom operation 'GenerateDri'.

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/dRis/generateDri/{companyKey}/{month}/{year}

POST /payrollPT/dRis/generateDri/{companyKey}/{month}/{year}

POST Submit Dri

Custom operation 'SubmitDri'.

The following elements are required:

companyKey	(string) CompanyKey.
month	(int) Month.
year	(int) Year.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dRis/submitDri/{companyKey}/{month}/{year}

POST /payrollPT/dRis/submitDri/{companyKey}/{month}/{year}

PUT Operations

PUT Set AccountDoc DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/accountDoc

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/accountDoc

PUT Set AccountDocId DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/accountDocId

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/accountDocId

PUT Set ClassificationType DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/classificationType

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/classificationType

PUT Set Company DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/company

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/company

PUT Set ContributionValue DRiResume

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/contributionValue

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/contributionValue

PUT Set Currency DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/currency

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/currency

PUT Set Currency DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/currency

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/currency

PUT Set Currency DRiResume

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/currency

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/currency

PUT Set Days DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/days

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/days

PUT Set DeliveryDate DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/deliveryDate

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/deliveryDate

PUT Set Description DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/description

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/description

PUT Set DRiKey DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiKey

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiKey

PUT Set DRiState DRi

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

The following elements are required:

dRiKey	(string) DRi.
companyKey	(string) The company key.
value	(enum DriState) The request body should contain the new value for the attribute. See DriState.

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/dRis/{companyKey}/{dRiKey}/dRiState

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiState

PUT Set Earnings DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/earnings

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/earnings

PUT Set EarningValue DRiResume

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/earningValue

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/earningValue

PUT Set Employee DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/employee

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/employee

PUT Set Independent DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/independent

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/independent

PUT Set IsActive DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/isActive

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/isActive

PUT Set IsCalculated DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/isCalculated

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/isCalculated

PUT Set IsIntegrated DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/isIntegrated

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/isIntegrated

PUT Set IsModified DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/isModified

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/isModified

PUT Set IsSubmited DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/isSubmited

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/isSubmited

PUT Set IsSubmitedWithErrors DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/isSubmitedWithErrors

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/isSubmitedWithErrors

PUT Set Nature DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/nature

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/nature

PUT Set Period DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/period

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/period

PUT Set Period DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/period

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/period

PUT Set Signal DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/signal

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/signal

PUT Set SubscriberId DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/subscriberId

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/subscriberId

PUT Set Tax DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/tax

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/tax

PUT Set Tax DRiResume

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/tax

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/tax

PUT Set TotContribProcessed DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/totContribProcessed

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/totContribProcessed

PUT Set TotRoundingDiference DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/totRoundingDiference

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/totRoundingDiference

PUT Set TotWorkLocContribTax DRi

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/totWorkLocContribTax

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/totWorkLocContribTax

PUT Set WorkLocation DRiDetail

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/workLocation

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}/workLocation

PUT Set WorkLocation DRiResume

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

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/workLocation

PUT /payrollPT/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}/workLocation

DELETE Operations

DELETE DRi Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}

DELETE /payrollPT/dRis/{companyKey}/{dRiKey}/dRiDetails/{lineId}

DELETE D Ri Resume by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

dRiKey	(string) DRi.
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/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}

DELETE /payrollPT/dRis/{companyKey}/{dRiKey}/dRiResumes/{lineId}

DELETE DRi 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/dRis/{id}

DELETE /payrollPT/dRis/{id}

DELETE DRi by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
dRiKey	(string) DRi.

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/dRis/{companyKey}/{dRiKey}

DELETE /payrollPT/dRis/{companyKey}/{dRiKey}

Resources

ApiDRiDRiDetailsProcessingDetailsResource

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.

ApiDRiDRiDetailsResource

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.
independent	(bool) Independent.
currency	(string) Currency.
isCalculated	(bool) Is Calculated.
isModified	(bool) Modified.

The following elements are optional:

days	(decimal) Days.
signal	(string) Signal.
processingDetails	(List of ApiDRiDRiDetailsProcessingDetailsResource) Processing Details. See ApiDRiDRiDetailsProcessingDetailsResource.
classificationType	(string) Classification Type.

ApiDRiDRiResumesResource

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.

ApiDRiResource

The following elements are required:

dRiKey	(string) DRi.
period	(DateTime) Period.
company	(string) Company.
currency	(string) Currency.
totContribProcessed	(MoneyResource) Total Contribution Processed. See MoneyResource .
totWorkLocContribTax	(MoneyResource) Total Work Location Contrib. / Tax. See MoneyResource .
totRoundingDiference	(MoneyResource) Total Rounding Diference. See MoneyResource .
isIntegrated	(bool) Integrated.
isSubmited	(bool) Is Submitted.

The following elements are optional:

dRiState	(enum DriState) State. See DriState.
description	(string) Description.
deliveryDate	(DateTime) Delivery Date.
dRiDetails	(List of ApiDRiDRiDetailsResource) D Ri Details. See ApiDRiDRiDetailsResource.
dRiResumes	(List of ApiDRiDRiResumesResource) D Ri Resumes. See ApiDRiDRiResumesResource.
accountDocId	(Guid) Account Doc Id.
accountDoc	(string) Accounting document.
isSubmitedWithErrors	(bool) Submitted With Errors.

DRiDetailResource

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.
independent	(bool) Independent.
currency	(string) Currency.
isCalculated	(bool) Is Calculated.
isModified	(bool) Modified.

The following elements are optional:

days	(decimal) Days.
signal	(string) Signal.
processingDetails	(List of DRiProcessingDetailResource) Processing Details. See DRiProcessingDetailResource.
classificationType	(string) Classification Type.

DriMainDRiDetailsResource

The following elements are required:

currency	(string) Currency.
earnings	(MoneyResource) Earnings. See MoneyResource .
employee	(string) Employee.
independent	(bool) Independent.
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.

DriMainDRiResumesResource

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.

DriMainResource

The following elements are required:

company	(string) Company.
currency	(string) Currency.
dRiKey	(string) DRi.
period	(DateTime) Period.
totContribProcessed	(MoneyResource) Total Contribution Processed. See MoneyResource .
totRoundingDiference	(MoneyResource) Total Rounding Diference. See MoneyResource .
totWorkLocContribTax	(MoneyResource) Total Work Location Contrib. / Tax. See MoneyResource .
isIntegrated	(bool) Integrated.
isSubmited	(bool) Is Submitted.

The following elements are optional:

deliveryDate	(DateTime) Delivery Date.
description	(string) Description.
dRiDetails	(List of DriMainDRiDetailsResource) D Ri Details. See DriMainDRiDetailsResource.
dRiState	(enum DriState) State. See DriState.
dRiResumes	(List of DriMainDRiResumesResource) D Ri Resumes. See DriMainDRiResumesResource.
accountDoc	(string) Accounting document.
isSubmitedWithErrors	(bool) Submitted With Errors.

DRiProcessingDetailResource

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.

DRiResource

The following elements are required:

dRiKey	(string) DRi.
period	(DateTime) Period.
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.
totContribProcessed	(MoneyResource) Total Contribution Processed. See MoneyResource .
totWorkLocContribTax	(MoneyResource) Total Work Location Contrib. / Tax. See MoneyResource .
totRoundingDiference	(MoneyResource) Total Rounding Diference. See MoneyResource .
isIntegrated	(bool) Integrated.
isSubmited	(bool) Is Submitted.

The following elements are optional:

dRiState	(enum DriState) State. See DriState.
description	(string) Description.
deliveryDate	(DateTime) Delivery Date.
dRiDetails	(List of DRiDetailResource) D Ri Details. See DRiDetailResource.
dRiResumes	(List of DRiResumeResource) D Ri Resumes. See DRiResumeResource.
accountDocId	(Guid) Account Doc Id.
accountDoc	(string) Accounting document.
isSubmitedWithErrors	(bool) Submitted With Errors.
deliveryId	(string) Delivery Id.

DRiResumeResource

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.

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

DriState

1	Processed
2	Sent
3	Validating
4	Delivered