Payroll | Bank File

Service to manage entities of type 'BankFile'. (Standalone subscriptions only).

Overview

api/{tenantKey}/{orgKey}/payroll/bankFiles

URL	api/{tenantKey}/{orgKey}/payroll/bankFiles
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:

ApiBankFileBankFileDetailsResource
ApiBankFileResource
BankFileDetailResource
BankFileResource
MoneyResource

GET Operations

GET BankFiles

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/bankFiles

GET /payroll/bankFiles

GET BankFiles (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 BankFileResource.

Response status codes:

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

Resource URL:

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

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

GET BankFile 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 BankFileResource.

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

GET /payroll/bankFiles/{id}

GET BankFile by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
bankFileKey	(string) Bank File.

Response:

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

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/bankFiles/{companyKey}/{bankFileKey}

GET /payroll/bankFiles/{companyKey}/{bankFileKey}

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

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

GET Print BankFile by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
bankFileKey	(string) Bank File.

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/bankFiles/{companyKey}/{bankFileKey}/print

GET /payroll/bankFiles/{companyKey}/{bankFileKey}/print

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

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

GET Original Print BankFile by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
bankFileKey	(string) Bank File.

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/bankFiles/{companyKey}/{bankFileKey}/printOriginal

GET /payroll/bankFiles/{companyKey}/{bankFileKey}/printOriginal

POST Operations

POST BankFiles

Creates a new entity record.

The following elements are required:

bankFileResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/bankFiles

POST /payroll/bankFiles

POST Bank File

Inserts a new 'Receipts' in the 'Bank File'.

The following elements are required:

bankFileKey	(string) Bank File.
companyKey	(string) The company key.
value	(ApiBankFileBankFileDetailsResource) The ApiBankFileBankFileDetailsResource instance. See ApiBankFileBankFileDetailsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails

POST /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails

POST Bank File Download

Get the bank file contents.

The following elements are required:

bankFileKey	(string) The bank file key.
companyKey	(string) The company key.

Response:

When successful, the response body contains a string.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/bankFiles/bankFileDownload/{bankFileKey}/{companyKey}

POST /payroll/bankFiles/bankFileDownload/{bankFileKey}/{companyKey}

PUT Operations

PUT Set BankAccount BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/bankAccount

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankAccount

PUT Set BankFileKey BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileKey

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileKey

PUT Set Company BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/company

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/company

PUT Set Contract BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/contract

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/contract

PUT Set Currency BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/currency

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/currency

PUT Set Employee BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/employee

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/employee

PUT Set EmployeeReceipt BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/employeeReceipt

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/employeeReceipt

PUT Set IBAN BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/iBAN

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/iBAN

PUT Set IsActive BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/isActive

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/isActive

PUT Set IsPrinted BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/isPrinted

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/isPrinted

PUT Set IsReprinted BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/isReprinted

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/isReprinted

PUT Set IsSigned BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/isSigned

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/isSigned

PUT Set PaymentMethod BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/paymentMethod

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/paymentMethod

PUT Set PrintedReportName BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/printedReportName

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/printedReportName

PUT Set Reference BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/reference

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/reference

PUT Set SWIFT BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/sWIFT

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/sWIFT

PUT Set TransferDate BankFile

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

The following elements are required:

bankFileKey	(string) Bank File.
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/bankFiles/{companyKey}/{bankFileKey}/transferDate

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/transferDate

PUT Set Value BankFileDetail

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

The following elements are required:

bankFileKey	(string) Bank File.
lineId	(string) The detail identifier.
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}/payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/value

PUT /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}/value

DELETE Operations

DELETE Receipts by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

bankFileKey	(string) Bank File.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}

DELETE /payroll/bankFiles/{companyKey}/{bankFileKey}/bankFileDetails/{lineId}

DELETE BankFile 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/bankFiles/{id}

DELETE /payroll/bankFiles/{id}

DELETE BankFile by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
bankFileKey	(string) Bank File.

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/bankFiles/{companyKey}/{bankFileKey}

DELETE /payroll/bankFiles/{companyKey}/{bankFileKey}

Resources

ApiBankFileBankFileDetailsResource

The following elements are required:

employeeReceipt	(string) Employee Receipt.
contract	(string) Contract.
employee	(string) Employee.
value	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

iBAN	(string) IBAN.
sWIFT	(string) SWIFT.
reference	(string) Reference.

ApiBankFileResource

The following elements are required:

bankFileKey	(string) Bank File.
transferDate	(DateTime) Transfer Date.
bankAccount	(string) Bank Account.
company	(string) Company.
paymentMethod	(string) Payment Method.

The following elements are optional:

bankFileDetails	(List of ApiBankFileBankFileDetailsResource) Bank File Details. See ApiBankFileBankFileDetailsResource.
printedReportName	(string) Printed Report Name.
isPrinted	(bool) Is Printed.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.

BankFileDetailResource

The following elements are required:

employeeReceipt	(string) Employee Receipt.
contract	(string) Contract.
employee	(string) Employee.
value	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

iBAN	(string) IBAN.
sWIFT	(string) SWIFT.
reference	(string) Reference.

BankFileResource

The following elements are required:

bankFileKey	(string) Bank File.
transferDate	(DateTime) Transfer Date.
bankAccount	(string) Bank Account.
company	(string) Company.
paymentMethod	(string) Payment Method.

The following elements are optional:

bankFileDetails	(List of BankFileDetailResource) Bank File Details. See BankFileDetailResource.
printedReportName	(string) Printed Report Name.
isPrinted	(bool) Is Printed.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.

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.