Payroll | Period Closing

Service to manage entities of type 'PeriodClosing'.

Overview

api/{tenantKey}/{orgKey}/payroll/periodClosings

URL	api/{tenantKey}/{orgKey}/payroll/periodClosings
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST PeriodClosings
PUT:
DELETE:
- DELETE PeriodClosing by identifier
- DELETE PeriodClosing by key

All Resources

This service uses the following resources:

ApiPeriodClosingResource
PeriodClosingResource

All Enumerations

This service uses the following enumerations:

PeriodClosingState

GET Operations

GET PeriodClosings

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/periodClosings

GET /payroll/periodClosings

GET PeriodClosings (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 PeriodClosingResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/periodClosings?page={page}&pageSize={pageSize}

GET /payroll/periodClosings?page={page}&pageSize={pageSize}

GET PeriodClosing 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 PeriodClosingResource.

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

GET /payroll/periodClosings/{id}

GET PeriodClosing by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
periodClosingKey	(string) Period Closing.

Response:

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

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}/payroll/periodClosings/{companyKey}/{periodClosingKey}

GET /payroll/periodClosings/{companyKey}/{periodClosingKey}

GET Print PeriodClosing 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}/payroll/periodClosings/{id}/print?template={template}

GET /payroll/periodClosings/{id}/print?template={template}

GET Print PeriodClosing by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
periodClosingKey	(string) Period Closing.

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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/print

GET /payroll/periodClosings/{companyKey}/{periodClosingKey}/print

GET Original Print PeriodClosingOriginal 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}/payroll/periodClosings/{id}/printOriginal?template={template}

GET /payroll/periodClosings/{id}/printOriginal?template={template}

GET Original Print PeriodClosing by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
periodClosingKey	(string) Period Closing.

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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/printOriginal

GET /payroll/periodClosings/{companyKey}/{periodClosingKey}/printOriginal

POST Operations

POST PeriodClosings

Creates a new entity record.

The following elements are required:

periodClosingResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/periodClosings

POST /payroll/periodClosings

PUT Operations

PUT Set Company PeriodClosing

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

The following elements are required:

periodClosingKey	(string) Period Closing.
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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/company

PUT /payroll/periodClosings/{companyKey}/{periodClosingKey}/company

PUT Set Description PeriodClosing

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

The following elements are required:

periodClosingKey	(string) Period Closing.
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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/description

PUT /payroll/periodClosings/{companyKey}/{periodClosingKey}/description

PUT Set IsActive PeriodClosing

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

The following elements are required:

periodClosingKey	(string) Period Closing.
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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/isActive

PUT /payroll/periodClosings/{companyKey}/{periodClosingKey}/isActive

PUT Set IsCompleted PeriodClosing

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

The following elements are required:

periodClosingKey	(string) Period Closing.
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:

api/{tenantKey}/{orgKey}/payroll/periodClosings/{companyKey}/{periodClosingKey}/isCompleted

PUT /payroll/periodClosings/{companyKey}/{periodClosingKey}/isCompleted

PUT Set Period PeriodClosing

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

The following elements are required:

periodClosingKey	(string) Period Closing.
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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/period

PUT /payroll/periodClosings/{companyKey}/{periodClosingKey}/period

PUT Set PeriodClosingKey PeriodClosing

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

The following elements are required:

periodClosingKey	(string) Period Closing.
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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/periodClosingKey

PUT /payroll/periodClosings/{companyKey}/{periodClosingKey}/periodClosingKey

PUT Set PeriodClosingState PeriodClosing

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

The following elements are required:

periodClosingKey	(string) Period Closing.
companyKey	(string) The company key.
value	(enum PeriodClosingState) The request body should contain the new value for the attribute. See PeriodClosingState.

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}/payroll/periodClosings/{companyKey}/{periodClosingKey}/periodClosingState

PUT /payroll/periodClosings/{companyKey}/{periodClosingKey}/periodClosingState

DELETE Operations

DELETE PeriodClosing 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}/payroll/periodClosings/{id}

DELETE /payroll/periodClosings/{id}

DELETE PeriodClosing by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
periodClosingKey	(string) Period Closing.

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}/payroll/periodClosings/{companyKey}/{periodClosingKey}

DELETE /payroll/periodClosings/{companyKey}/{periodClosingKey}

Resources

ApiPeriodClosingResource

The following elements are required:

periodClosingKey	(string) Period Closing.
period	(DateTime) Period.
company	(string) Company.
isCompleted	(bool) Is Completed.

The following elements are optional:

description	(string) Description.
periodClosingState	(enum PeriodClosingState) State. See PeriodClosingState.

PeriodClosingResource

The following elements are required:

periodClosingKey	(string) Period Closing.
period	(DateTime) Period.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
isCompleted	(bool) Is Completed.

The following elements are optional:

description	(string) Description.
periodClosingState	(enum PeriodClosingState) State. See PeriodClosingState.

Enumerations

PeriodClosingState

1	Processing
2	Completed
3	Failed