Payroll | Payroll Setup

Service to manage entities of type 'PayrollCoreSetup'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups

URL	api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST PayrollCoreSetups
- POST Payroll Setup
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiPayrollCoreSetupEntityDimensionDetailsResource
ApiPayrollCoreSetupResource
EntityDimensionDetailResource
PayrollCoreSetupResource

GET Operations

GET PayrollCoreSetups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups

GET /payrollCore/payrollCoreSetups

GET PayrollCoreSetups (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 PayrollCoreSetupResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups?page={page}&pageSize={pageSize}

GET /payrollCore/payrollCoreSetups?page={page}&pageSize={pageSize}

GET PayrollCoreSetup 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 PayrollCoreSetupResource.

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

GET /payrollCore/payrollCoreSetups/{id}

GET PayrollCoreSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) Company.

Response:

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

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}/payrollCore/payrollCoreSetups/{company}

GET /payrollCore/payrollCoreSetups/{company}

GET Print PayrollCoreSetup 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}/payrollCore/payrollCoreSetups/{id}/print?template={template}

GET /payrollCore/payrollCoreSetups/{id}/print?template={template}

GET Print PayrollCoreSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) Company.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/print

GET /payrollCore/payrollCoreSetups/{company}/print

GET Original Print PayrollCoreSetupOriginal 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}/payrollCore/payrollCoreSetups/{id}/printOriginal?template={template}

GET /payrollCore/payrollCoreSetups/{id}/printOriginal?template={template}

GET Original Print PayrollCoreSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) Company.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/printOriginal

GET /payrollCore/payrollCoreSetups/{company}/printOriginal

POST Operations

POST PayrollCoreSetups

Creates a new entity record.

The following elements are required:

payrollCoreSetupResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups

POST /payrollCore/payrollCoreSetups

POST Payroll Setup

Inserts a new 'Entity Dimension Detail' in the 'Payroll Setup'.

The following elements are required:

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

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}/payrollCore/payrollCoreSetups/{company}/entityDimensionDetails

POST /payrollCore/payrollCoreSetups/{company}/entityDimensionDetails

PUT Operations

PUT Set BaseNonWorkingDays PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/baseNonWorkingDays

PUT /payrollCore/payrollCoreSetups/{company}/baseNonWorkingDays

PUT Set BaseSchedule PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/baseSchedule

PUT /payrollCore/payrollCoreSetups/{company}/baseSchedule

PUT Set Company PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/company

PUT /payrollCore/payrollCoreSetups/{company}/company

PUT Set Dimension EntityDimensionDetail

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

The following elements are required:

company	(string) Company.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/entityDimensionDetails/{lineId}/dimension

PUT /payrollCore/payrollCoreSetups/{company}/entityDimensionDetails/{lineId}/dimension

PUT Set DuplicateReceiptPrinting PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/duplicateReceiptPrinting

PUT /payrollCore/payrollCoreSetups/{company}/duplicateReceiptPrinting

PUT Set IntegratedReceiptsEmail PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/integratedReceiptsEmail

PUT /payrollCore/payrollCoreSetups/{company}/integratedReceiptsEmail

PUT Set IntegratedReceiptsEmailTemplate PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/integratedReceiptsEmailTemplate

PUT /payrollCore/payrollCoreSetups/{company}/integratedReceiptsEmailTemplate

PUT Set IntegratedReceiptsPassword PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/integratedReceiptsPassword

PUT /payrollCore/payrollCoreSetups/{company}/integratedReceiptsPassword

PUT Set IsActive PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/isActive

PUT /payrollCore/payrollCoreSetups/{company}/isActive

PUT Set JournalType PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/journalType

PUT /payrollCore/payrollCoreSetups/{company}/journalType

PUT Set OriginalState EntityDimensionDetail

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

The following elements are required:

company	(string) Company.
lineId	(string) The detail identifier.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/entityDimensionDetails/{lineId}/originalState

PUT /payrollCore/payrollCoreSetups/{company}/entityDimensionDetails/{lineId}/originalState

PUT Set WorkRuleSet PayrollCoreSetup

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

The following elements are required:

company	(string) Company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/workRuleSet

PUT /payrollCore/payrollCoreSetups/{company}/workRuleSet

DELETE Operations

DELETE Entity Dimension Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company	(string) Company.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/payrollCoreSetups/{company}/entityDimensionDetails/{lineId}

DELETE /payrollCore/payrollCoreSetups/{company}/entityDimensionDetails/{lineId}

DELETE PayrollCoreSetup 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}/payrollCore/payrollCoreSetups/{id}

DELETE /payrollCore/payrollCoreSetups/{id}

DELETE PayrollCoreSetup by key

Deletes the entity record that matches the specified key.

The following elements are required:

company

(string) Company.

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}/payrollCore/payrollCoreSetups/{company}

DELETE /payrollCore/payrollCoreSetups/{company}

Resources

ApiPayrollCoreSetupEntityDimensionDetailsResource

The following elements are required:

dimension

(string) Dimension.

The following elements are optional:

originalState

(bool) If false indicate the dimension as changed (no db).

ApiPayrollCoreSetupResource

The following elements are required:

company	(string) Company.
duplicateReceiptPrinting	(bool) Duplicate Receipt Printing.

The following elements are optional:

journalType	(string) Journal Type.
baseNonWorkingDays	(string) Base Non Working Days.
baseSchedule	(string) Base Schedule.
entityDimensionDetails	(List of ApiPayrollCoreSetupEntityDimensionDetailsResource) Entity Dimension Details. See ApiPayrollCoreSetupEntityDimensionDetailsResource.
workRuleSet	(string) Work Rule Set.
integratedReceiptsEmail	(string) Emails where integrated receipts will be sent.
integratedReceiptsPassword	(string) The password to decrypt the integrated receipt.
integratedReceiptsEmailTemplate	(string) Emails template of integrated receipts.

EntityDimensionDetailResource

The following elements are required:

dimension

(string) Dimension.

The following elements are optional:

originalState

(bool) If false indicate the dimension as changed (no db).

PayrollCoreSetupResource

The following elements are required:

company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
duplicateReceiptPrinting	(bool) Duplicate Receipt Printing.

The following elements are optional:

journalType	(string) Journal Type. (fk) Allowed value: the natural key of a record of type JournalType.
baseNonWorkingDays	(string) Base Non Working Days. (fk) Allowed value: the natural key of a record of type NonWorkingDay.
baseSchedule	(string) Base Schedule. (fk) Allowed value: the natural key of a record of type Schedule. These records are accessibly through the Schedules service.
entityDimensionDetails	(List of EntityDimensionDetailResource) Entity Dimension Details. See EntityDimensionDetailResource.
workRuleSet	(string) Work Rule Set. (fk) Allowed value: the natural key of a record of type WorkRuleSet. These records are accessibly through the WorkRuleSets service.
integratedReceiptsEmail	(string) Emails where integrated receipts will be sent.
integratedReceiptsPassword	(string) The password to decrypt the integrated receipt.
integratedReceiptsEmailTemplate	(string) Emails template of integrated receipts. (fk) Allowed value: the natural key of a record of type EmailTemplate.