Payroll | Formula
Service to manage entities of type 'Formula'.
Overview
| URL | api/{tenantKey}/{orgKey}/payrollCore/formulas |
| 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:
All Enumerations
This service uses the following enumerations:
GET Formulas
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See FormulaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Formulas (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 FormulaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Formula 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 FormulaResource. |
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 Formula by key
Returns the entity record that matches the specified key.
The following elements are required:
| formulaKey | (string) Formula. |
Response:
| When successful, the response body contains the entity record. See FormulaResource. |
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 Formula 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 Formula by key
Prints the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
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 FormulaOriginal 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 Formula by key
Prints the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
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 Formulas
Creates a new entity record.
The following elements are required:
| formulaResource | (ApiFormulaResource) The request body should contain the entity record that should be created. See ApiFormulaResource. |
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 ApiFormulaResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DescriptionExpression Formula
Updates the value of attribute 'DescriptionExpression' in the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
| 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:
PUT Set Expression Formula
Updates the value of attribute 'Expression' in the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
| 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:
PUT Set FormulaApplication Formula
Updates the value of attribute 'FormulaApplication' in the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
| value | (enum FormulaApplication) The request body should contain the new value for the attribute. See FormulaApplication. |
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:
PUT Set FormulaKey Formula
Updates the value of attribute 'FormulaKey' in the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
| 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:
PUT Set IsActive Formula
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
| 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:
PUT Set Name Formula
Updates the value of attribute 'Name' in the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
| 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:
PUT Set Parser Formula
Updates the value of attribute 'Parser' in the specified entity record.
The following elements are required:
| formulaKey | (string) Formula. |
| 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:
DELETE Formula 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 Formula by key
Deletes the entity record that matches the specified key.
The following elements are required:
| formulaKey | (string) Formula. |
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
ApiFormulaResource
The following elements are required:
| formulaKey | (string) Formula. |
| name | (string) Name. |
| expression | (string) Expression. |
| descriptionExpression | (string) Description Expression. |
| formulaApplication | (enum FormulaApplication) Applies to.
See FormulaApplication. |
The following elements are optional:
| parser | (string) The Parser namespace. |
FormulaResource
The following elements are required:
| formulaKey | (string) Formula. |
| name | (string) Name. |
| expression | (string) Expression. |
| descriptionExpression | (string) Description Expression. |
| formulaApplication | (enum FormulaApplication) Applies to.
See FormulaApplication. |
The following elements are optional:
| parser | (string) The Parser namespace. |