Payroll | Batch Extra Earning
Service to manage entities of type 'BatchExtraEarning'.
Overview
| URL | api/{tenantKey}/{orgKey}/payrollCore/batchExtraEarnings |
| Methods Supported | GET, POST, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- DELETE:
All Resources
This service uses the following resources:
- ApiBatchExtraEarningBatchExtraEarningDetailsResource
- ApiBatchExtraEarningResource
- BatchExtraEarningDetailResource
- BatchExtraEarningResource
- MoneyResource
All Enumerations
This service uses the following enumerations:
GET BatchExtraEarnings
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See BatchExtraEarningResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET BatchExtraEarnings (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 BatchExtraEarningResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET BatchExtraEarning 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 BatchExtraEarningResource. |
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:
GET BatchExtraEarning by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| batchExtraEarningKey | (int) Batch Extra Earning. |
Response:
| When successful, the response body contains the entity record. See BatchExtraEarningResource. |
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:
GET Print BatchExtraEarning 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:
GET Print BatchExtraEarning by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| batchExtraEarningKey | (int) Batch 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:
GET Original Print BatchExtraEarningOriginal 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:
GET Original Print BatchExtraEarning by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| batchExtraEarningKey | (int) Batch 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:
POST BatchExtraEarnings
Creates a new entity record.
The following elements are required:
| batchExtraEarningResource | (ApiBatchExtraEarningResource) The request body should contain the entity record that should be created. See ApiBatchExtraEarningResource. |
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 ApiBatchExtraEarningResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE BatchExtraEarning 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:
DELETE BatchExtraEarning by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| batchExtraEarningKey | (int) Batch 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:
Resources
ApiBatchExtraEarningBatchExtraEarningDetailsResource
The following elements are required:
| extraEarning | (string) Extra Earning. |
| 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. |
| employee | (string) Employee. |
ApiBatchExtraEarningResource
The following elements are required:
| company | (string) Company. |
The following elements are optional:
| description | (string) Description. |
| batchExtraEarningDetails | (List of ApiBatchExtraEarningBatchExtraEarningDetailsResource) Batch Extra Earning Details.
See ApiBatchExtraEarningBatchExtraEarningDetailsResource. |
BatchExtraEarningDetailResource
The following elements are required:
| extraEarning | (string) Extra Earning. |
| 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. |
| employee | (string) Employee. |
BatchExtraEarningResource
The following elements are required:
| batchExtraEarningKey | (int) Batch Extra Earning. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. |
The following elements are optional:
| description | (string) Description. |
| batchExtraEarningDetails | (List of BatchExtraEarningDetailResource) Batch Extra Earning Details.
See BatchExtraEarningDetailResource. |
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.