Payroll | Benefit Account Entry

Service to manage entities of type 'BenefitAccountEntry'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET BenefitAccountEntries
  • GET BenefitAccountEntries (paged)
  • GET BenefitAccountEntry by identifier
  • GET BenefitAccountEntry by key
  • GET Print BenefitAccountEntry by identifier
  • GET Print BenefitAccountEntry by key
  • GET Original Print BenefitAccountEntryOriginal by identifier
  • GET Original Print BenefitAccountEntry by key
• POST:
  • POST BenefitAccountEntries
• PUT:
  • PUT Set IsActive BenefitAccountEntry
  • PUT Set BenefitAccountEntryKey BenefitAccountEntry
  • PUT Set Contract BenefitAccountEntry
  • PUT Set BenefitAccountType BenefitAccountEntry
  • PUT Set Period BenefitAccountEntry
  • PUT Set EntryType BenefitAccountEntry
  • PUT Set Credit BenefitAccountEntry
  • PUT Set Debit BenefitAccountEntry
  • PUT Set Notes BenefitAccountEntry
  • PUT Set Company BenefitAccountEntry
  • PUT Set Index BenefitAccountEntry
  • PUT Set IsEditable BenefitAccountEntry
  • PUT Set SourceSchemaEntity BenefitAccountEntry
  • PUT Set SourceId BenefitAccountEntry
  • PUT Set SourceKey BenefitAccountEntry
• DELETE:
  • DELETE BenefitAccountEntry by identifier
  • DELETE BenefitAccountEntry by key

All Resources

This service uses the following resources:

• ApiBenefitAccountEntryResource
• BenefitAccountEntryResource

All Enumerations

This service uses the following enumerations:

• BenefitAccountEntryType

GET Operations

GET BenefitAccountEntries

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET BenefitAccountEntries (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 BenefitAccountEntryResource.

Response status codes:

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

Resource URL:

GET BenefitAccountEntry 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 BenefitAccountEntryResource.

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 BenefitAccountEntry by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
benefitAccountEntryKey	(string) Benefit Account Entry.

Response:

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

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 BenefitAccountEntry 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 BenefitAccountEntry by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
benefitAccountEntryKey	(string) Benefit Account Entry.

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 BenefitAccountEntryOriginal 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 BenefitAccountEntry by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
benefitAccountEntryKey	(string) Benefit Account Entry.

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 Operations

POST BenefitAccountEntries

Creates a new entity record.

The following elements are required:

benefitAccountEntryResource

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

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set BenefitAccountEntryKey BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set BenefitAccountType BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set Company BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set Contract BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set Credit BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set Debit BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set EntryType BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
companyKey	(string) The company key.
value	(enum BenefitAccountEntryType) The request body should contain the new value for the attribute. See BenefitAccountEntryType.

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 Index BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
companyKey	(string) The company key.
value	(int) 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 BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set IsEditable BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set Notes BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set Period BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set SourceId BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set SourceKey BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

PUT Set SourceSchemaEntity BenefitAccountEntry

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

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
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:

DELETE Operations

DELETE BenefitAccountEntry 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 BenefitAccountEntry by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
benefitAccountEntryKey	(string) Benefit Account Entry.

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

ApiBenefitAccountEntryResource

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
contract	(string) Contract.
benefitAccountType	(string) Benefit Account Type.
period	(DateTime) Period.
entryType	(enum BenefitAccountEntryType) Entry Type. See BenefitAccountEntryType.
credit	(decimal) Credit.
debit	(decimal) Debit.
notes	(string) Description.
company	(string) Company.
index	(int) Index.
isEditable	(bool) Is Editable.
isInitialBalance	(bool) controls the entry type in UI.

The following elements are optional:

sourceSchemaEntity	(string) The schema entity id that originated the benefit account entry creation.
sourceId	(Guid) The entity id that originated the benefit account entry creation.
sourceKey	(string) The entity key that originated the benefit account entry creation.

BenefitAccountEntryResource

The following elements are required:

benefitAccountEntryKey	(string) Benefit Account Entry.
contract	(string) Contract. (fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.
benefitAccountType	(string) Benefit Account Type. (fk) Allowed value: the natural key of a record of type BenefitAccountType. These records are accessibly through the BenefitAccountTypes service.
period	(DateTime) Period.
entryType	(enum BenefitAccountEntryType) Entry Type. See BenefitAccountEntryType.
credit	(decimal) Credit.
debit	(decimal) Debit.
accCredit	(decimal) Accumulated Credit.
accDebit	(decimal) Accumulated Debit.
balance	(decimal) Balance.
notes	(string) Description.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
index	(int) Index.
isEditable	(bool) Is Editable.
isInitialBalance	(bool) controls the entry type in UI.

The following elements are optional:

employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
sourceSchemaEntity	(string) The schema entity id that originated the benefit account entry creation. (fk) Allowed value: the natural key of a record of type SchemaEntity.
sourceId	(Guid) The entity id that originated the benefit account entry creation.
sourceKey	(string) The entity key that originated the benefit account entry creation.

Enumerations

BenefitAccountEntryType

5	InitialBalance
10	ProcessingCredit
20	UserCredit
30	UserDebit
40	Absence
50	ProcessingDebit
60	VocationalTraining