Payroll | Extra Earning

Service to manage entities of type 'ExtraEarning'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/extraEarnings

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

All Operations

This service includes the following operations:

GET:
POST:
- POST ExtraEarnings
PUT:
DELETE:
- DELETE ExtraEarning by identifier
- DELETE ExtraEarning by key

All Resources

This service uses the following resources:

ApiExtraEarningResource
ExtraEarningResource
MoneyResource

All Enumerations

This service uses the following enumerations:

EarningValueKind
Timing

GET Operations

GET ExtraEarnings

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/extraEarnings

GET /payrollCore/extraEarnings

GET ExtraEarnings (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 ExtraEarningResource.

Response status codes:

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

Resource URL:

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

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

GET ExtraEarning 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 ExtraEarningResource.

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

GET /payrollCore/extraEarnings/{id}

GET ExtraEarning by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
extraEarningKey	(int) Extra Earning.

Response:

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

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/extraEarnings/{companyKey}/{extraEarningKey}

GET /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}

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

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

GET Print ExtraEarning by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
extraEarningKey	(int) Extra Earning.

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/extraEarnings/{companyKey}/{extraEarningKey}/print

GET /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/print

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

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

GET Original Print ExtraEarning by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
extraEarningKey	(int) Extra Earning.

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/extraEarnings/{companyKey}/{extraEarningKey}/printOriginal

GET /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/printOriginal

POST Operations

POST ExtraEarnings

Creates a new entity record.

The following elements are required:

extraEarningResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/extraEarnings

POST /payrollCore/extraEarnings

PUT Operations

PUT Set BatchExtraEarning ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/batchExtraEarning

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/batchExtraEarning

PUT Set Currency ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/currency

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/currency

PUT Set Earning ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/earning

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/earning

PUT Set IsActive ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/isActive

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/isActive

PUT Set Notes ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/notes

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/notes

PUT Set Period ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/period

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/period

PUT Set Quantity ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/quantity

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/quantity

PUT Set ReferenceDate ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/referenceDate

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/referenceDate

PUT Set Timing ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
companyKey	(string) The company key.
value	(enum Timing) The request body should contain the new value for the attribute. See Timing.

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/extraEarnings/{companyKey}/{extraEarningKey}/timing

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/timing

PUT Set ValueFormula ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/valueFormula

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/valueFormula

PUT Set ValueKind ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
companyKey	(string) The company key.
value	(enum EarningValueKind) The request body should contain the new value for the attribute. See EarningValueKind.

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/extraEarnings/{companyKey}/{extraEarningKey}/valueKind

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/valueKind

PUT Set ValueMoney ExtraEarning

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

The following elements are required:

extraEarningKey	(int) Extra Earning.
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}/payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/valueMoney

PUT /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}/valueMoney

DELETE Operations

DELETE ExtraEarning 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/extraEarnings/{id}

DELETE /payrollCore/extraEarnings/{id}

DELETE ExtraEarning by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
extraEarningKey	(int) Extra Earning.

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/extraEarnings/{companyKey}/{extraEarningKey}

DELETE /payrollCore/extraEarnings/{companyKey}/{extraEarningKey}

Resources

ApiExtraEarningResource

The following elements are required:

contract	(string) Contract.
earning	(string) Earning.
period	(DateTime) Period.
company	(string) Company.
timing	(enum Timing) Timing. See Timing.
valueKind	(enum EarningValueKind) Value Kind. See EarningValueKind.
valueMoney	(MoneyResource) Value Money. See MoneyResource .
currency	(string) Currency.
referenceDate	(DateTime) Reference Date.

The following elements are optional:

quantity	(decimal) Quantity.
valueFormula	(string) Value Formula.
notes	(string) Notes.
batchExtraEarning	(string) Batch.

ExtraEarningResource

The following elements are required:

extraEarningKey	(int) Extra Earning.
contract	(string) Contract. (fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.
earning	(string) Earning. (fk) Allowed value: the natural key of a record of type Earning. These records are accessibly through the Earnings service.
period	(DateTime) Period.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
timing	(enum Timing) Timing. See Timing.
valueKind	(enum EarningValueKind) Value Kind. See EarningValueKind.
valueMoney	(MoneyResource) Value Money. See MoneyResource .
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency.
referenceDate	(DateTime) Reference Date.

The following elements are optional:

quantity	(decimal) Quantity.
valueFormula	(string) Value Formula. (fk) Allowed value: the natural key of a record of type Formula. These records are accessibly through the Formulas service.
notes	(string) Notes.
employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
batchExtraEarning	(string) Batch. (fk) Allowed value: the natural key of a record of type BatchExtraEarning. These records are accessibly through the BatchExtraEarnings service.

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

EarningValueKind

1	Money
2	Formula

Timing

1	Advance
2	Regular
3	Posterior